thinkgeo.mapsuite.core.gdiplusrastersource
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.gdiplusrastersource [2015/09/21 01:03] admin |
thinkgeo.mapsuite.core.gdiplusrastersource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GdiPlusRasterSource ====== | ====== ThinkGeo.MapSuite.Core.GdiPlusRasterSource ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class allows you to view standard .NET GDI+ image types such as BMP, TIF, JPG, and PNG. | This class allows you to view standard .NET GDI+ image types such as BMP, TIF, JPG, and PNG. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource() ** | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource() ** | ||
| - | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String) ** | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String) ** | ||
| - | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back. | + | * //You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 27: | Line 30: | ||
| ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,String) ** | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,String) ** | ||
| - | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back. | + | * //You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 42: | Line 45: | ||
| ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,RectangleShape) ** | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,RectangleShape) ** | ||
| - | This is the constructor the for the class. | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back. | + | * //You can specify a path and filename that does not actually exist if you use the StreamLoading event. This event only uses the PathFileName parameter as a unique string that will be passed to you in the event, so that you can determine what stream you want to pass back.// |
| == Parameters == | == Parameters == | ||
| * //imagePathFilename// | * //imagePathFilename// | ||
| Line 59: | Line 62: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 71: | Line 74: | ||
| ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 83: | Line 86: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 95: | Line 98: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 107: | Line 110: | ||
| ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 119: | Line 122: | ||
| ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 131: | Line 134: | ||
| ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 143: | Line 146: | ||
| ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 155: | Line 158: | ||
| ** {{wiki:PublicMethod.gif|}} Open() ** | ** {{wiki:PublicMethod.gif|}} Open() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 167: | Line 170: | ||
| ** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 179: | Line 182: | ||
| ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 203: | Line 206: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 215: | Line 218: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 231: | Line 234: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 243: | Line 246: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 256: | Line 259: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | This method allows you to raise the StreamLoading event. | + | * //This method allows you to raise the StreamLoading event.// |
| == Remarks == | == Remarks == | ||
| - | This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes, so we exposed a way to raise the event as necessary through this protected method. | + | * //This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes, so we exposed a way to raise the event as necessary through this protected method.// |
| == Return Value == | == Return Value == | ||
| Line 272: | Line 275: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** | ||
| - | This method returns the width of the image in screen coordinates. | + | * //This method returns the width of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the width of the image in screen coordinates. | + | * //This method returns the width of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 284: | Line 287: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** | ||
| - | This method returns the height of the image in screen coordinates. | + | * //This method returns the height of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the height of the image in screen coordinates. | + | * //This method returns the height of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| Line 296: | Line 299: | ||
| ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | ||
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the ImageSource. Most methods on the ImageSource will throw an exception if the state of the ImageSource is not opened. When the map draws each layer, it will open the ImageSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the ImageSource. When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the ImageSource. | + | * //This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the ImageSource. Most methods on the ImageSource will throw an exception if the state of the ImageSource is not opened. When the map draws each layer, it will open the ImageSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the ImageSource. When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the ImageSource.// |
| == Return Value == | == Return Value == | ||
| Line 308: | Line 311: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | ||
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | This protected virtual method is called from the concrete public method Close. The Close method plays an important role in the life cycle of the ImageSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. | + | * //This protected virtual method is called from the concrete public method Close. The Close method plays an important role in the life cycle of the ImageSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.// |
| == Return Value == | == Return Value == | ||
| Line 320: | Line 323: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** | ||
| - | This method returns an image based on the worldExtent, image width and image height. | + | * //This method returns an image based on the worldExtent, image width and image height.// |
| == Remarks == | == Remarks == | ||
| - | This method is responsible for returning the image based on the parameters passed in. | + | * //This method is responsible for returning the image based on the parameters passed in.// |
| == Return Value == | == Return Value == | ||
| Line 344: | Line 347: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | ||
| - | This method returns the bounding box of the RasterSource. | + | * //This method returns the bounding box of the RasterSource.// |
| == Remarks == | == Remarks == | ||
| - | This method returns the bounding box of the RasterSource. | + | * //This method returns the bounding box of the RasterSource.// |
| == Return Value == | == Return Value == | ||
| Line 356: | Line 359: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 372: | Line 375: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 388: | Line 391: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 404: | Line 407: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 420: | Line 423: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 432: | Line 435: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 441: | Line 444: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenWidth// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenHeight// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //wrappingExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //boundingBox// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenWidth// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //screenHeight// | ||
| + | * Type:Double | ||
| + | * Description:N/A | ||
| + | |||
| + | * //wrappingExtent// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 456: | Line 515: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 573: | Line 632: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} GettingSourceImage ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.GettingSourceImageEventArgs|GettingSourceImageEventArgs]] | ||
| - | |||
| - | ** {{wiki:PublicEvent.gif|}} GottenSourceImage ** | ||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.GottenSourceImageEventArgs|GottenSourceImageEventArgs]] | ||
| - | |||
| ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ||
| This event allows you to pass in your own stream to represent the image. | This event allows you to pass in your own stream to represent the image. | ||
thinkgeo.mapsuite.core.gdiplusrastersource.1442797420.txt.gz ยท Last modified: 2015/09/21 01:03 by admin