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/17 10:29] 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 6: | Line 9: | ||
| ***ThinkGeo.MapSuite.Core.GdiPlusRasterSource** | ***ThinkGeo.MapSuite.Core.GdiPlusRasterSource** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#GdiPlusRasterSource()|GdiPlusRasterSource]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is the constructor the for the class. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is the constructor the for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GdiPlusRasterSource(String)|GdiPlusRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:String | + | * //None// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor the for the class. | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String) ** |
| - | <div class_table> | + | * //This is the constructor the for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GdiPlusRasterSource(String,String)|GdiPlusRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:String,String | + | * //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.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor the for the class. | + | * //imagePathFilename// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter represents the image you want to load. | ||
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GdiPlusRasterSource(String,RectangleShape)|GdiPlusRasterSource]]** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,String) ** |
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is the constructor the for the class. | + | |
| - | </div> | + | |
| - | === Protected Constructors === | + | * //This is the constructor the for the class.// |
| - | === Public Methods === | + | == Remarks == |
| - | <div class_table> | + | * //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.// |
| - | **{{wiki:PublicMethod.gif|}}[[#CloneDeep()|CloneDeep]]** | + | == Parameters == |
| - | * **Parameters**:N/A | + | * //imagePathFilename// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | * Type:String |
| - | * **Summary**:N/A | + | * Description:This parameter represents the image you want to load. |
| - | </div> | + | |
| - | <div class_table> | + | * //worldfilePathFilename// |
| - | **{{wiki:PublicMethod.gif|}}[[#Close()|Close]]** | + | * Type:String |
| - | * **Parameters**:N/A | + | * Description:This parameter represents the world file path and filename you want to load. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | ** {{wiki:PublicMethod.gif|}} GdiPlusRasterSource(String,RectangleShape) ** |
| - | * **Parameters**:Object | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is the constructor the for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetBoundingBox()|GetBoundingBox]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //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.// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | == Parameters == |
| - | * **Summary**:N/A | + | * //imagePathFilename// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter represents the image you want to load. | ||
| - | <div class_table> | + | * //imageExtent// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Parameters**:N/A | + | * Description:This parameter represents the extnet of the image you want to load. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHorizontalResolution()|GetHorizontalResolution]]** | + | ==== Protected Constructors ==== |
| - | * **Parameters**:N/A | + | ==== Public Methods ==== |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImage(RectangleShape,Int32,Int32)|GetImage]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Int32 | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImageHeight()|GetImageHeight]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImageWidth()|GetImageWidth]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetProjectionText()|GetProjectionText]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:String |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetVerticalResolution()|GetVerticalResolution]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetImageWidth() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetWorldFileText()|GetWorldFileText]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#Open()|Open]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | * //N/A// |
| - | <div class_table> | + | == Remarks == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloneDeepCore()|CloneDeepCore]]** | + | * //N/A// |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloseCore()|CloseCore]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the bounding box of the RasterSource. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageCore(RectangleShape,Int32,Int32)|GetImageCore]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Int32 | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an image based on the worldExtent, image width and image height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageHeightCore()|GetImageHeightCore]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the height of the image in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageWidthCore()|GetImageWidthCore]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the width of the image in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetProjectionTextCore()|GetProjectionTextCore]]** | + | * Type:Single |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnClosedRasterSource(ClosedRasterSourceEventArgs)|OnClosedRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnClosingRasterSource(ClosingRasterSourceEventArgs)|OnClosingRasterSource]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnOpenedRasterSource(OpenedRasterSourceEventArgs)|OnOpenedRasterSource]]** | + | <div newline></div> |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnOpeningRasterSource(OpeningRasterSourceEventArgs)|OnOpeningRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnStreamLoading(StreamLoadingEventArgs)|OnStreamLoading]]** | + | * Type:String |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method allows you to raise the StreamLoading event. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OpenCore()|OpenCore]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | </div> | + | |
| - | === Public Properties === | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#BlueTranslation|BlueTranslation]]** | + | == Remarks == |
| - | * **Return**:Single | + | * //N/A// |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicProperty.gif|}}[[#FileName|FileName]]** | + | == Return Value == |
| - | * **Return**:String | + | * Type:Void |
| - | * **Summary**:This property returns the filename part of the PathFileName. | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#FilePath|FilePath]]** | + | == Parameters == |
| - | * **Return**:String | + | <div newline></div> |
| - | * **Summary**:This property returns the path part of the PathFileName. | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
| - | **{{wiki:PublicProperty.gif|}}[[#GreenTranslation|GreenTranslation]]** | + | * //N/A// |
| - | * **Return**:Single | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#HasProjectionText|HasProjectionText]]** | + | == Return Value == |
| - | * **Return**:Boolean | + | * Type:Void |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#IsGrayscale|IsGrayscale]]** | + | == Parameters == |
| - | * **Return**:Boolean | + | <div newline></div> |
| - | * **Summary**:This property gets and sets whether the image shows in grayscale. | + | ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** |
| - | **{{wiki:PublicProperty.gif|}}[[#IsNegative|IsNegative]]** | + | * //N/A// |
| - | * **Return**:Boolean | + | == Remarks == |
| - | * **Summary**:This property gets and sets whether the image shows as negative (inverted colors). | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#IsOpen|IsOpen]]** | + | == Return Value == |
| - | * **Return**:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#PathFilename|PathFilename]]** | + | == Parameters == |
| - | * **Return**:String | + | * //worldExtent// |
| - | * **Summary**:This property returns the path and filename of the image you want to represent. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:N/A | ||
| - | **{{wiki:PublicProperty.gif|}}[[#Projection|Projection]]** | + | * //canvasWidth// |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.Projection|Projection]] | + | * Type:Int32 |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#RedTranslation|RedTranslation]]** | + | * //canvasHeight// |
| - | * **Return**:Single | + | * Type:Int32 |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#Transparency|Transparency]]** | + | <div newline></div> |
| - | * **Return**:Single | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Summary**:N/A | + | |
| - | === Protected Properties === | + | * //N/A// |
| - | **{{wiki:ProtectedProperty.gif|}}[[#HasProjectionTextCore|HasProjectionTextCore]]** | + | == Remarks == |
| - | * **Return**:Boolean | + | * //N/A// |
| - | * **Summary**:N/A | + | |
| - | === Public Events === | + | == Return Value == |
| - | **{{wiki:PublicEvent.gif|}}[[#ClosedRasterSource|ClosedRasterSource]]** | + | * Type:String |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicEvent.gif|}}[[#ClosingRasterSource|ClosingRasterSource]]** | + | == Parameters == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | **{{wiki:PublicEvent.gif|}}[[#OpenedRasterSource|OpenedRasterSource]]** | + | * //N/A// |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicEvent.gif|}}[[#OpeningRasterSource|OpeningRasterSource]]** | + | == Return Value == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | * Type:Boolean |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicEvent.gif|}}[[#StreamLoading|StreamLoading]]** | + | == Parameters == |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | + | * //obj// |
| - | * **Summary**:This event allows you to pass in your own stream to represent the image. | + | * Type:Object |
| + | * Description:N/A | ||
| - | ===== Public Constructors ===== | + | <div newline></div> |
| - | === GdiPlusRasterSource() === | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | This is the constructor the for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | None | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | === GdiPlusRasterSource(String) === | + | |
| - | This is the constructor the for the class. | + | |
| - | ==== 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. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the image you want to load. | + | |
| - | [[#Public Constructors|Go Back]] | + | * //N/A// |
| - | === GdiPlusRasterSource(String,String) === | + | == Remarks == |
| - | This is the constructor the for the class. | + | * //N/A// |
| - | ==== 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. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the image you want to load. | + | |
| - | **worldfilePathFilename** | + | == Return Value == |
| - | * **Type**:String | + | * Type:Int32 |
| - | * **Description:This parameter represents the world file path and filename you want to load. | + | * Description:N/A |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | === GdiPlusRasterSource(String,RectangleShape) === | + | <div newline></div> |
| - | This is the constructor the for the class. | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | ==== 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. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the image you want to load. | + | |
| - | **imageExtent** | + | * //N/A// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description:This parameter represents the extnet of the image you want to load. | + | * //N/A// |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:Type |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | === CloneDeep() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ==== Protected Methods ==== |
| + | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | ==== Parameters ==== | + | * //This method allows you to raise the StreamLoading event.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === Close() === | + | * //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.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //e// |
| - | === Equals(Object) === | + | * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] |
| - | N/A | + | * Description:This parameter represents the event arguments you want to raise the StreamLoading event with. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Boolean | + | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //This method returns the width of the image in screen coordinates.// |
| - | **obj** | + | == Remarks == |
| - | * **Type**:Object | + | * //This method returns the width of the image in screen coordinates.// |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === GetBoundingBox() === | + | * Type:Int32 |
| - | N/A | + | * Description:This method returns the width of the image in screen coordinates. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** |
| - | ==== Parameters ==== | + | * //This method returns the height of the image in screen coordinates.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetHashCode() === | + | * //This method returns the height of the image in screen coordinates.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Int32 | + | * Type:Int32 |
| - | * **Description**:N/A | + | * Description:This method returns the height of the image in screen coordinates. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === GetHorizontalResolution() === | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| - | * **Return Type**:Single | + | == Remarks == |
| - | * **Description**: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.// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === GetImage(RectangleShape,Int32,Int32) === | + | * Description:None |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
| - | ==== Parameters ==== | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| - | **worldExtent** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //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.// |
| - | * **Description**:N/A | + | |
| - | **canvasWidth** | + | == Return Value == |
| - | * **Type**:Int32 | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | **canvasHeight** | + | == Parameters == |
| - | * **Type**:Int32 | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** |
| - | [[#Public Methods|Go Back]] | + | * //This method returns an image based on the worldExtent, image width and image height.// |
| - | === GetImageHeight() === | + | == Remarks == |
| - | N/A | + | * //This method is responsible for returning the image based on the parameters passed in.// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Int32 | + | * 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 == |
| - | [[#Public Methods|Go Back]] | + | * //worldExtent// |
| - | === GetImageWidth() === | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | N/A | + | * Description:This parameter represents the worldExtent you want to draw. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //canvasWidth// |
| - | * **Return Type**:Int32 | + | * Type:Int32 |
| - | * **Description**:N/A | + | * Description:This parameter represents the width of the image you want to draw. |
| - | ==== Parameters ==== | + | * //canvasHeight// |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | === GetProjectionText() === | + | * Description:This parameter represents the height of the image you want to draw. |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:String | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //This method returns the bounding box of the RasterSource.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetType() === | + | * //This method returns the bounding box of the RasterSource.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Type | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:N/A | + | * Description:This method returns the bounding box of the RasterSource. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === GetVerticalResolution() === | + | ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Single | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === GetWorldFileText() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:String | + | * //e// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** |
| - | === Open() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === ToString() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:String | + | * //e// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** |
| - | ===== Protected Methods ===== | + | |
| - | === CloneDeepCore() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | === CloseCore() === | + | * Description:N/A |
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | ==== 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. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //e// |
| - | * **Description**:None | + | * Type:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** |
| - | === Finalize() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | === GetBoundingBoxCore() === | + | * Description:N/A |
| - | This method returns the bounding box of the RasterSource. | + | |
| - | ==== Remarks ==== | + | |
| - | This method returns the bounding box of the RasterSource. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //e// |
| - | * **Description**:This method returns the bounding box of the RasterSource. | + | * Type:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** |
| - | === GetImageCore(RectangleShape,Int32,Int32) === | + | |
| - | This method returns an image based on the worldExtent, image width and image height. | + | |
| - | ==== Remarks ==== | + | |
| - | This method is responsible for returning the image based on the parameters passed in. | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | == Remarks == |
| - | * **Description**:This method returns an image based on the worldExtent, image width and image height. | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:N/A |
| - | * **Description**:This parameter represents the worldExtent you want to draw. | + | |
| - | **canvasWidth** | + | == Parameters == |
| - | * **Type**:Int32 | + | <div newline></div> |
| - | * **Description**:This parameter represents the width of the image you want to draw. | + | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** |
| - | **canvasHeight** | + | * //N/A// |
| - | * **Type**:Int32 | + | == Remarks == |
| - | * **Description**:This parameter represents the height of the image you want to draw. | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Return Value == |
| - | === GetImageHeightCore() === | + | * Type:String |
| - | This method returns the height of the image in screen coordinates. | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | This method returns the height of the image in screen coordinates. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | <div newline></div> |
| - | * **Description**:This method returns the height of the image in screen coordinates. | + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | === GetImageWidthCore() === | + | * //N/A// |
| - | This method returns the width of the image in screen coordinates. | + | |
| - | ==== Remarks ==== | + | |
| - | This method returns the width of the image in screen coordinates. | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:This method returns the width of the image in screen coordinates. | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | * //boundingBox// |
| - | === GetProjectionTextCore() === | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:String | + | * Type:Double |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | [[#Protected Methods|Go Back]] | + | * Type:Double |
| - | === MemberwiseClone() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //wrappingExtent// |
| - | * **Return Type**:Object | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** |
| - | === OnClosedRasterSource(ClosedRasterSourceEventArgs) === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **e** | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | == Parameters == |
| - | === OnClosingRasterSource(ClosingRasterSourceEventArgs) === | + | * //boundingBox// |
| - | N/A | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | ==== Remarks ==== | + | * Description:N/A |
| - | N/A | + | |
| - | **Return Value** | + | * //screenWidth// |
| - | * **Return Type**:Void | + | * Type:Double |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | * //screenHeight// |
| - | **e** | + | * Type:Double |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | * //wrappingExtent// |
| - | === OnOpenedRasterSource(OpenedRasterSourceEventArgs) === | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Void | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **e** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | == Return Value == |
| - | === OnOpeningRasterSource(OpeningRasterSourceEventArgs) === | + | * Type:Void |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | **e** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | * //N/A// |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | == Return Value == |
| - | === OnStreamLoading(StreamLoadingEventArgs) === | + | * Type:Object |
| - | This method allows you to raise the StreamLoading event. | + | * Description:N/A |
| - | ==== 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. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | <div newline></div> |
| - | * **Description**:None | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} IsNegative ** | ||
| - | ==== Parameters ==== | + | This property gets and sets whether the image shows as negative (inverted colors). |
| - | **e** | + | == Remarks == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | + | You can set this property to show the negative of the image. |
| - | * **Description**:This parameter represents the event arguments you want to raise the StreamLoading event with. | + | == Return Value == |
| + | * Type:Boolean | ||
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** |
| - | === OpenCore() === | + | |
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | ==== 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. | + | |
| - | **Return Value** | + | This property gets and sets whether the image shows in grayscale. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None | + | This property allows you to show the image in grayscale. |
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| - | ==== Parameters ==== | + | ** {{wiki:PublicProperty.gif|}} FileName ** |
| - | [[#Protected Methods|Go Back]] | + | |
| - | ===== Public Properties ===== | + | |
| - | === BlueTranslation === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Single | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === FileName === | ||
| This property returns the filename part of the PathFileName. | This property returns the filename part of the PathFileName. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| None | None | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:String |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} FilePath ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === FilePath === | ||
| This property returns the path part of the PathFileName. | This property returns the path part of the PathFileName. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| None | None | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:String | + | * Type:String |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} PathFilename ** | ||
| + | |||
| + | This property returns the path and filename of the image you want to represent. | ||
| + | == Remarks == | ||
| + | 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 == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Projection ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === GreenTranslation === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]] |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Transparency ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === HasProjectionText === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Single |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** |
| - | === IsGrayscale === | + | |
| - | This property gets and sets whether the image shows in grayscale. | + | |
| - | ==== Remarks ==== | + | |
| - | This property allows you to show the image in grayscale. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Boolean | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === IsNegative === | ||
| - | This property gets and sets whether the image shows as negative (inverted colors). | ||
| - | ==== Remarks ==== | ||
| - | You can set this property to show the negative of the image. | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Boolean | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === IsOpen === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Single |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** |
| - | === PathFilename === | + | |
| - | This property returns the path and filename of the image you want to represent. | + | |
| - | ==== Remarks ==== | + | |
| - | 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 Type**:String | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === Projection === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.Projection|Projection]] | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === RedTranslation === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === Transparency === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Boolean |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | === HasProjectionTextCore === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Boolean |
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} HasProjectionTextCore ** | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | === ClosedRasterSource === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | ==== 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]] | ||
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** |
| - | === ClosingRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** |
| - | === OpenedRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** |
| - | === OpeningRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** |
| - | === 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.StreamLoadingEventArgs|StreamLoadingEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | ||
thinkgeo.mapsuite.core.gdiplusrastersource.1442485755.txt.gz · Last modified: 2015/09/17 10:29 by admin