thinkgeo.mapsuite.portablecore.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.portablecore.gdiplusrastersource [2015/09/23 01:25] admin |
thinkgeo.mapsuite.portablecore.gdiplusrastersource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.GdiPlusRasterLayer ====== | + | ====== ThinkGeo.MapSuite.Core.GdiPlusRasterSource ====== |
| - | This class represents general image types to be drawn on the map, such as .BMP, .JPG, .PNG, etc. | + | |
| + | {{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. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| *System.Object | *System.Object | ||
| - | *ThinkGeo.MapSuite.Core.Layer | + | *ThinkGeo.MapSuite.Core.RasterSource |
| - | *ThinkGeo.MapSuite.Core.RasterLayer | + | ***ThinkGeo.MapSuite.Core.GdiPlusRasterSource** |
| - | ***ThinkGeo.MapSuite.Core.GdiPlusRasterLayer** | + | |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterLayer() ** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource() ** |
| - | * //This is a constructor for the class.// | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | * //If you use this constructor, then you need to set the PathFileName property manually before using the layer.// | + | * //None// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterLayer(String) ** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String) ** |
| - | * //This is a constructor for the class.// | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | * //This constructor gets the layer ready to use.// | + | * //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 == | ||
| - | * //pathFilename// | + | * //imagePathFilename// |
| * Type:String | * Type:String | ||
| - | * Description:This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance. | + | * Description:This parameter represents the image you want to load. |
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterLayer(String,String) ** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,String) ** |
| - | * //This is a constructor for the class.// | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | * //This constructor gets the layer ready to use.// | + | * //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 == | ||
| - | * //pathFilename// | + | * //imagePathFilename// |
| * Type:String | * Type:String | ||
| - | * Description:This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance. | + | * Description:This parameter represents the image you want to load. |
| * //worldfilePathFilename// | * //worldfilePathFilename// | ||
| * Type:String | * Type:String | ||
| - | * Description:This parameter is the world file path and filename for the GDI+ image you want to use. | + | * Description:This parameter represents the world file path and filename you want to load. |
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterLayer(String,RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,RectangleShape) ** |
| - | * //This is a constructor for the class.// | + | * //This is the constructor the for the class.// |
| == Remarks == | == Remarks == | ||
| - | * //This constructor gets the layer ready to use.// | + | * //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 == | ||
| - | * //pathFilename// | + | * //imagePathFilename// |
| * Type:String | * Type:String | ||
| - | * Description:This parameter is the path and filename of the GDI+ image file you want to use. If you want to load a Tiff(.tif or .tiff) files, please use the GeoTiffRasterLayer instead for better performance. | + | * Description:This parameter represents the image you want to load. |
| * //imageExtent// | * //imageExtent// | ||
| * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:This parameter is the image extent of GDI+ image file you want to use. | + | * Description:This parameter represents the extnet of the image you want to load. |
| <div newline></div> | <div newline></div> | ||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| * //N/A// | * //N/A// | ||
| Line 65: | Line 67: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** | + | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** |
| * //N/A// | * //N/A// | ||
| Line 77: | Line 79: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** | + | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** |
| * //N/A// | * //N/A// | ||
| Line 89: | Line 91: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:Int32 |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** | + | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** |
| * //N/A// | * //N/A// | ||
| Line 101: | Line 103: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | + | * Type:Int32 |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | + | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** |
| * //N/A// | * //N/A// | ||
| Line 113: | Line 115: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | + | * Type:Single |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Open() ** | + | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** |
| * //N/A// | * //N/A// | ||
| Line 125: | Line 127: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:Single |
| - | * Description:N/A | + | |
| - | + | ||
| - | == Parameters == | + | |
| - | <div newline></div> | + | |
| - | ** {{wiki:PublicMethod.gif|}} Close() ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | == Return Value == | + | |
| - | * Type:Void | + | |
| * Description:N/A | * Description:N/A | ||
| Line 154: | Line 144: | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) ** | + | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** |
| * //N/A// | * //N/A// | ||
| Line 161: | Line 151: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //labelsInAllLayers// | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing() ** | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
| * //N/A// | * //N/A// | ||
| Line 186: | Line 168: | ||
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
| * //N/A// | * //N/A// | ||
| Line 197: | Line 179: | ||
| == Parameters == | == Parameters == | ||
| - | * //extentToRefresh// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) ** | + | ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** |
| * //N/A// | * //N/A// | ||
| Line 209: | Line 187: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //extentsToRefresh// | + | * //worldExtent// |
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | <div newline></div> | + | |
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | == Return Value == | + | |
| - | * Type:Void | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | == Parameters == | + | |
| - | * //bufferTime// | + | |
| - | * Type:TimeSpan | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | <div newline></div> | + | |
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | == Return Value == | + | |
| - | * Type:Void | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | == Parameters == | + | |
| - | * //extentToRefresh// | + | |
| * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | ||
| * Description:N/A | * Description:N/A | ||
| - | * //bufferTime// | + | * //canvasWidth// |
| - | * Type:TimeSpan | + | * Type:Int32 |
| - | * Description:N/A | + | |
| - | + | ||
| - | <div newline></div> | + | |
| - | ** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | == Return Value == | + | |
| - | * Type:Void | + | |
| - | * Description:N/A | + | |
| - | + | ||
| - | == Parameters == | + | |
| - | * //extentsToRefresh// | + | |
| - | * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | + | |
| * Description:N/A | * Description:N/A | ||
| - | * //bufferTime// | + | * //canvasHeight// |
| - | * Type:TimeSpan | + | * Type:Int32 |
| * Description:N/A | * Description:N/A | ||
| Line 327: | Line 257: | ||
| <div newline></div> | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) ** | + | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** |
| - | * //This method will draw the image from the GeoImage source based on the parameters provided.// | + | * //This method allows you to raise the StreamLoading event.// |
| == Remarks == | == Remarks == | ||
| - | * //The DrawCore method will be called when the layer is being drawn. It will determine if the image is within the extent and the threshold defined. If these parameters are met, it will query the RasterSource for an image and then apply the other various properties (such as transparency, etc.) on the image. Lastly, it will draw the image on the GeoImage or native image passed into the 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 338: | Line 268: | ||
| == Parameters == | == Parameters == | ||
| - | * //canvas// | + | * //e// |
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] |
| - | * Description:This parameter is the GeoCanvas used to Draw the RasterLayer. | + | * Description:This parameter represents the event arguments you want to raise the StreamLoading event with. |
| - | + | ||
| - | * //labelsInAllLayers// | + | |
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> | + | |
| - | * Description:This parameter is not used for ImageLayers. | + | |
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** | + | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** |
| - | * //N/A// | + | * //This method returns the width of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //This method returns the width of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Type:Int32 |
| - | * Description:N/A | + | * Description:This method returns the width of the image in screen coordinates. |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** | + | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** |
| - | * //N/A// | + | * //This method returns the height of the image in screen coordinates.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //This method returns the height of the image in screen coordinates.// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:Int32 |
| - | * Description:N/A | + | * Description:This method returns the height of the image in screen coordinates. |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | * //N/A// | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //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 == | ||
| * Type:Void | * Type:Void | ||
| - | * Description:N/A | + | * Description:None |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
| - | * //N/A// | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //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 == | ||
| * Type:Void | * Type:Void | ||
| - | * Description:N/A | + | * Description:None |
| == Parameters == | == Parameters == | ||
| - | * //eventArgs// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** | + | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** |
| - | * //N/A// | + | * //This method returns an image based on the worldExtent, image width and image height.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //This method is responsible for returning the image based on the parameters passed in.// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * Description:N/A | + | * Description:This method returns an image based on the worldExtent, image width and image height. |
| == Parameters == | == Parameters == | ||
| - | <div newline></div> | + | * //worldExtent// |
| - | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:This parameter represents the worldExtent you want to draw. | ||
| - | * //N/A// | + | * //canvasWidth// |
| - | == Remarks == | + | * Type:Int32 |
| - | * //N/A// | + | * Description:This parameter represents the width of the image you want to draw. |
| - | == Return Value == | + | * //canvasHeight// |
| - | * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] | + | * Type:Int32 |
| - | * Description:N/A | + | * Description:This parameter represents the height of the image you want to draw. |
| - | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** |
| - | * //N/A// | + | * //This method returns the bounding box of the RasterSource.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //This method returns the bounding box of the RasterSource.// |
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * Description:N/A | + | * Description:This method returns the bounding box of the RasterSource. |
| == Parameters == | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | * //e// | ||
| - | * Type:Exception | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** | + | ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** |
| * //N/A// | * //N/A// | ||
| Line 454: | Line 368: | ||
| == Parameters == | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| * //e// | * //e// | ||
| - | * Type:Exception | + | * Type:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** | + | ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** |
| * //N/A// | * //N/A// | ||
| Line 475: | Line 385: | ||
| == Parameters == | == Parameters == | ||
| * //e// | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** | + | ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** |
| * //N/A// | * //N/A// | ||
| Line 491: | Line 401: | ||
| == Parameters == | == Parameters == | ||
| * //e// | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** | + | ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** |
| * //N/A// | * //N/A// | ||
| Line 506: | Line 416: | ||
| == Parameters == | == Parameters == | ||
| - | * //canvas// | + | * //e// |
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | + | * Type:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
| - | * Description:N/A | + | |
| - | + | ||
| - | * //attribution// | + | |
| - | * Type:String | + | |
| * Description:N/A | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
| * //N/A// | * //N/A// | ||
| Line 522: | Line 428: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //args// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** | + | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** |
| * //N/A// | * //N/A// | ||
| Line 538: | Line 440: | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Void | + | * Type:String |
| * Description:N/A | * Description:N/A | ||
| == Parameters == | == Parameters == | ||
| - | * //args// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //eventArgs// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | ||
| - | * Description:N/A | ||
| - | |||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| Line 604: | Line 470: | ||
| <div newline></div> | <div newline></div> | ||
| ==== Public Properties ==== | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** | ||
| - | |||
| - | * //This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. In GdiPlusRasterLayer, we override this API and mark it as true.// | ||
| - | == Remarks == | ||
| - | * //The default implementation in the base class returns false.// | ||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} PathFilename ** | ||
| - | |||
| - | * //This property gets and sets the path and filename of the image file you want to use.// | ||
| - | == Remarks == | ||
| - | * //This should be a complete path and filename for the image file.// | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} RedTranslation ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | ||
| - | |||
| - | * //N/A// | ||
| - | == Remarks == | ||
| - | * //N/A// | ||
| - | == Return Value == | ||
| - | * Type:Single | ||
| - | |||
| ** {{wiki:PublicProperty.gif|}} IsNegative ** | ** {{wiki:PublicProperty.gif|}} IsNegative ** | ||
| - | * //N/A// | + | * //This property gets and sets whether the image shows as negative (inverted colors).// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //You can set this property to show the negative of the image.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 654: | Line 480: | ||
| ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** | ||
| - | * //N/A// | + | * //This property gets and sets whether the image shows in grayscale.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //This property allows you to show the image in grayscale.// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| - | ** {{wiki:PublicProperty.gif|}} ImageSource ** | + | ** {{wiki:PublicProperty.gif|}} FileName ** |
| - | * //N/A// | + | * //This property returns the filename part of the PathFileName.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | * Type:String |
| - | ** {{wiki:PublicProperty.gif|}} UpperThreshold ** | + | ** {{wiki:PublicProperty.gif|}} FilePath ** |
| - | * //N/A// | + | * //This property returns the path part of the PathFileName.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //None// |
| == Return Value == | == Return Value == | ||
| - | * Type:Double | + | * Type:String |
| - | ** {{wiki:PublicProperty.gif|}} LowerThreshold ** | + | ** {{wiki:PublicProperty.gif|}} PathFilename ** |
| - | * //N/A// | + | * //This property returns the path and filename of the image you want to represent.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //When you specify the path and filename, it should be in the correct format as such; however, the file does not need to actually exist on the file system. This is to allow us to accept streams supplied by the developer at runtime. If you choose to provide a file that exists, we will attempt to use it. If we cannot find it, then we will raise the SteamLoading event and allow you to supply the stream. For example, you can pass in "C:\NotARealPath\File1.jpg" which does not exist on the file system. When we raise the event for you to supply a stream, we will pass to you the path and filename so you can differentiate the files.// |
| == Return Value == | == Return Value == | ||
| - | * Type:Double | + | * Type:String |
| - | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** | + | ** {{wiki:PublicProperty.gif|}} Projection ** |
| * //N/A// | * //N/A// | ||
| Line 690: | Line 516: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]] |
| - | ** {{wiki:PublicProperty.gif|}} KeyColors ** | + | ** {{wiki:PublicProperty.gif|}} Transparency ** |
| * //N/A// | * //N/A// | ||
| Line 698: | Line 524: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} IsOpen ** | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
| * //N/A// | * //N/A// | ||
| Line 706: | Line 532: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Boolean | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} DrawingTime ** | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
| * //N/A// | * //N/A// | ||
| Line 714: | Line 540: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:TimeSpan | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} Name ** | + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** |
| * //N/A// | * //N/A// | ||
| Line 722: | Line 548: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:String | + | * Type:Single |
| - | ** {{wiki:PublicProperty.gif|}} IsVisible ** | + | ** {{wiki:PublicProperty.gif|}} IsOpen ** |
| * //N/A// | * //N/A// | ||
| Line 732: | Line 558: | ||
| * Type:Boolean | * Type:Boolean | ||
| - | ** {{wiki:PublicProperty.gif|}} Transparency ** | + | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** |
| * //N/A// | * //N/A// | ||
| Line 738: | Line 564: | ||
| * //N/A// | * //N/A// | ||
| == Return Value == | == Return Value == | ||
| - | * Type:Single | + | * Type:Boolean |
| - | + | ||
| - | ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | == Return Value == | + | |
| - | * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | + | |
| - | + | ||
| - | ** {{wiki:PublicProperty.gif|}} Attribution ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | == Return Value == | + | |
| - | * Type:String | + | |
| - | + | ||
| - | ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** | + | |
| - | + | ||
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | == Return Value == | + | |
| - | * Type:TimeSpan | + | |
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** | + | ** {{wiki:ProtectedProperty.gif|}} HasProjectionTextCore ** |
| * //N/A// | * //N/A// | ||
| Line 774: | Line 576: | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ||
| - | * //This event allows you to pass in your own stream to represent the image.// | ||
| - | == Remarks == | ||
| - | * //If you wish, you can pass in your own stream to represent the image. The stream can come from a variety of places, including isolated storage, a compressed file, or an encrypted stream. When the image is finished with the stream it will dispose of it, so be sure to keep this in mind when passing the stream in. If you do not pass in an alternate stream, the class will attempt to load the file from the file system using the PathFileName property.// | ||
| - | |||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | |||
| ** {{wiki:PublicEvent.gif|}} GettingSourceImage ** | ** {{wiki:PublicEvent.gif|}} GettingSourceImage ** | ||
| * //N/A// | * //N/A// | ||
| Line 795: | Line 590: | ||
| Event Arguments:[[ThinkGeo.MapSuite.Core.GottenSourceImageEventArgs|GottenSourceImageEventArgs]] | Event Arguments:[[ThinkGeo.MapSuite.Core.GottenSourceImageEventArgs|GottenSourceImageEventArgs]] | ||
| - | ** {{wiki:PublicEvent.gif|}} DrawingException ** | + | ** {{wiki:PublicEvent.gif|}} StreamLoading ** |
| - | * //N/A// | + | * //This event allows you to pass in your own stream to represent the image.// |
| == Remarks == | == Remarks == | ||
| - | * //N/A// | + | * //If you wish, you can pass in your own stream to represent the image. The stream can come from a variety of places, including isolated storage, a compressed file, or an encrypted stream. When the image is finished with the stream it will dispose of it, so be sure to keep this in mind when passing the stream in. If you do not pass in an alternate stream, the class will attempt to load the file from the file system using the PathFileName property.// |
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] |
| - | + | ||
| - | ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** | + | |
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | + | |
| - | + | ||
| - | ** {{wiki:PublicEvent.gif|}} DrawnException ** | + | |
| - | * //N/A// | + | |
| - | == Remarks == | + | |
| - | * //N/A// | + | |
| - | + | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] | + | |
| - | ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** | + | ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** |
| * //N/A// | * //N/A// | ||
| == Remarks == | == Remarks == | ||
| * //N/A// | * //N/A// | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] |
| - | ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** | + | ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** |
| * //N/A// | * //N/A// | ||
| == Remarks == | == Remarks == | ||
| * //N/A// | * //N/A// | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| - | ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** | + | ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** |
| * //N/A// | * //N/A// | ||
| == Remarks == | == Remarks == | ||
| * //N/A// | * //N/A// | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| - | ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** | + | ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** |
| * //N/A// | * //N/A// | ||
| == Remarks == | == Remarks == | ||
| * //N/A// | * //N/A// | ||
| - | Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
thinkgeo.mapsuite.portablecore.gdiplusrastersource.1442971527.txt.gz · Last modified: 2015/09/23 01:25 by admin