thinkgeo.mapsuite.core.mrsidrastersource
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.mrsidrastersource [2015/09/17 10:35] admin |
thinkgeo.mapsuite.core.mrsidrastersource [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.MrSidRasterSource ====== | ====== ThinkGeo.MapSuite.Core.MrSidRasterSource ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents the MrSid raster source. | This class represents the MrSid raster source. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 6: | Line 9: | ||
| ***ThinkGeo.MapSuite.Core.MrSidRasterSource** | ***ThinkGeo.MapSuite.Core.MrSidRasterSource** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#MrSidRasterSource()|MrSidRasterSource]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is the constructor for the class. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is the constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#MrSidRasterSource(String)|MrSidRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:String | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor for the class. | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String) ** |
| - | <div class_table> | + | * //This is the constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#MrSidRasterSource(String,String)|MrSidRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:String,String | + | * //This is typically the constructor you want to use for this class. It allows you to pass in the MrSid file you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class.// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:This is the constructor for the class. | + | * //imagePathFilename// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter represents the path and file name of the MrSid file you want to load into the class for display. | ||
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#MrSidRasterSource(String,RectangleShape)|MrSidRasterSource]]** | + | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,String) ** |
| - | * **Parameters**:String,[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This is a constructor for the class. | + | |
| - | </div> | + | |
| - | === Protected Constructors === | + | * //This is the constructor for the class.// |
| - | === Public Methods === | + | == Remarks == |
| - | <div class_table> | + | * //This is typically the constructor you want to use for this class. It allows you to pass in the MrSid file and world file path and filename you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class.// |
| - | **{{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 path and file name of the MrSid file you want to load into the class for display. |
| - | </div> | + | |
| - | <div class_table> | + | * //worldFilePathFilename// |
| - | **{{wiki:PublicMethod.gif|}}[[#Close()|Close]]** | + | * Type:String |
| - | * **Parameters**:N/A | + | * Description:This parameter represents the world file path and file name of the MrSid file you want to use |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Dispose()|Dispose]]** | + | ** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,RectangleShape) ** |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Release the unmanage resource by setting the rasterImage to null. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //This is a constructor for the class.// |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Remarks == |
| - | * **Parameters**:Object | + | * //This constructor gets the RasterSource ready to use.// |
| - | * **DeclaringType**:Object | + | == Parameters == |
| - | * **Summary**:N/A | + | * //imagePathFilename// |
| - | </div> | + | * Type:String |
| + | * Description:This parameter is the path and file name of the Sid source you want to use. | ||
| - | <div class_table> | + | * //imageExtent// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetBoundingBox()|GetBoundingBox]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Parameters**:N/A | + | * Description:This parameter is the image extent of sid source you want to use. |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | ==== Protected Constructors ==== |
| - | * **Parameters**:N/A | + | ==== Public Methods ==== |
| - | * **DeclaringType**:Object | + | ** {{wiki:PublicMethod.gif|}} Dispose() ** |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //Release the unmanage resource by setting the rasterImage to null.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHorizontalResolution()|GetHorizontalResolution]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImage(RectangleShape,Int32,Int32)|GetImage]]** | + | * Type:Void |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Int32 | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImageHeight()|GetImageHeight]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetImageWidth()|GetImageWidth]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetProjectionText()|GetProjectionText]]** | + | * 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|}}[[#GetType()|GetType]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetVerticalResolution()|GetVerticalResolution]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#GetWorldFileText()|GetWorldFileText]]** | + | * Type:String |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#Open()|Open]]** | + | <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|}}[[#ToString()|ToString]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | == Return Value == |
| - | <div class_table> | + | * Type:Int32 |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloneDeepCore()|CloneDeepCore]]** | + | * Description:N/A |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#CloseCore()|CloseCore]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetImageHeight() ** |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]]** | + | * Type:Int32 |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the bounding box of the RasterSource. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageCore(RectangleShape,Int32,Int32)|GetImageCore]]** | + | <div newline></div> |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]],Int32,Int32 | + | ** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns an image based on the worldExtent and image width and height. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageHeightCore()|GetImageHeightCore]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the height of the image in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageWidthCore()|GetImageWidthCore]]** | + | * Type:Single |
| - | * **Parameters**:N/A | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the width of the image in screen coordinates. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetProjectionTextCore()|GetProjectionTextCore]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:This method returns the projection text in proj4 format. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnClosedRasterSource(ClosedRasterSourceEventArgs)|OnClosedRasterSource]]** | + | * Type:Single |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnClosingRasterSource(ClosingRasterSourceEventArgs)|OnClosingRasterSource]]** | + | <div newline></div> |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnOpenedRasterSource(OpenedRasterSourceEventArgs)|OnOpenedRasterSource]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | * //N/A// |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnOpeningRasterSource(OpeningRasterSourceEventArgs)|OnOpeningRasterSource]]** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **DeclaringType**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:ProtectedMethod.gif|}}[[#OpenCore()|OpenCore]]** | + | <div newline></div> |
| - | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetProjectionText() ** |
| - | * **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|}}[[#GreenTranslation|GreenTranslation]]** | + | == Return Value == |
| - | * **Return**:Single | + | * Type:String |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#HasProjectionText|HasProjectionText]]** | + | == Parameters == |
| - | * **Return**:Boolean | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} Open() ** |
| - | **{{wiki:PublicProperty.gif|}}[[#IsGrayscale|IsGrayscale]]** | + | * //N/A// |
| - | * **Return**:Boolean | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#IsNegative|IsNegative]]** | + | == Return Value == |
| - | * **Return**:Boolean | + | * Type:Void |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#IsOpen|IsOpen]]** | + | == Parameters == |
| - | * **Return**:Boolean | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} Close() ** |
| - | **{{wiki:PublicProperty.gif|}}[[#PathFilename|PathFilename]]** | + | * //N/A// |
| - | * **Return**:String | + | == Remarks == |
| - | * **Summary**:This property gets or sets the file name and path of the MrSid image you are working with. | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#Projection|Projection]]** | + | == Return Value == |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.Projection|Projection]] | + | * Type:Void |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicProperty.gif|}}[[#RedTranslation|RedTranslation]]** | + | == Parameters == |
| - | * **Return**:Single | + | <div newline></div> |
| - | * **Summary**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** |
| - | **{{wiki:PublicProperty.gif|}}[[#SuppressClose|SuppressClose]]** | + | * //N/A// |
| - | * **Return**:Boolean | + | == Remarks == |
| - | * **Summary**:Gets or sets the SuppressClose property. | + | * //N/A// |
| - | **{{wiki:PublicProperty.gif|}}[[#Transparency|Transparency]]** | + | == Return Value == |
| - | * **Return**:Single | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | === Protected Properties === | + | == Parameters == |
| - | **{{wiki:ProtectedProperty.gif|}}[[#HasProjectionTextCore|HasProjectionTextCore]]** | + | * //worldExtent// |
| - | * **Return**:Boolean | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Summary**:This property returns true if the RasterSource has projection text, false if it does not. | + | * Description:N/A |
| - | === Public Events === | + | * //canvasWidth// |
| - | **{{wiki:PublicEvent.gif|}}[[#ClosedRasterSource|ClosedRasterSource]]** | + | * Type:Int32 |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicEvent.gif|}}[[#ClosingRasterSource|ClosingRasterSource]]** | + | * //canvasHeight// |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | * Type:Int32 |
| - | * **Summary**:N/A | + | * Description:N/A |
| - | **{{wiki:PublicEvent.gif|}}[[#OpenedRasterSource|OpenedRasterSource]]** | + | <div newline></div> |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Summary**:N/A | + | |
| - | **{{wiki:PublicEvent.gif|}}[[#OpeningRasterSource|OpeningRasterSource]]** | + | * //N/A// |
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | == Remarks == |
| - | * **Summary**:N/A | + | * //N/A// |
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | === MrSidRasterSource() === | + | * Type:String |
| - | This is the constructor for the class. | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | === MrSidRasterSource(String) === | + | |
| - | This is the constructor for the class. | + | |
| - | ==== Remarks ==== | + | |
| - | This is typically the constructor you want to use for this class. It allows you to pass in the MrSid file you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the path and file name of the MrSid file you want to load into the class for display. | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | === MrSidRasterSource(String,String) === | + | <div newline></div> |
| - | This is the constructor for the class. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | ==== Remarks ==== | + | |
| - | This is typically the constructor you want to use for this class. It allows you to pass in the MrSid file and world file path and filename you wish to work with. Note that the MrSid file is not accessed or opened until you call the open command of the class. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter represents the path and file name of the MrSid file you want to load into the class for display. | + | |
| - | **worldFilePathFilename** | + | * //N/A// |
| - | * **Type**:String | + | == Remarks == |
| - | * **Description:This parameter represents the world file path and file name of the MrSid file you want to use | + | * //N/A// |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | === MrSidRasterSource(String,RectangleShape) === | + | * Type:Boolean |
| - | This is a constructor for the class. | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | This constructor gets the RasterSource ready to use. | + | |
| - | ==== Parameters ==== | + | |
| - | **imagePathFilename** | + | |
| - | * **Type**:String | + | |
| - | * **Description:This parameter is the path and file name of the Sid source you want to use. | + | |
| - | **imageExtent** | + | == Parameters == |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * //obj// |
| - | * **Description:This parameter is the image extent of sid source you want to use. | + | * Type:Object |
| + | * Description:N/A | ||
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ===== Public Methods ===== | + | |
| - | === CloneDeep() === | + | |
| - | 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 == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | === Close() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === Dispose() === | + | * //N/A// |
| - | Release the unmanage resource by setting the rasterImage to null. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:Type |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Equals(Object) === | + | ==== Protected Methods ==== |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //This method returns the width of the image in screen coordinates.// |
| - | * **Return Type**:Boolean | + | == Remarks == |
| - | * **Description**:N/A | + | * //This method returns the width of the image in screen coordinates.// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **obj** | + | * Type:Int32 |
| - | * **Type**:Object | + | * Description:This method returns the width of the image in screen coordinates. |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === GetBoundingBox() === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //This method returns the height of the image in screen coordinates.// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:N/A | + | * //This method returns the height of the image in screen coordinates.// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | === GetHashCode() === | + | * Description:This method returns the height of the image in screen coordinates. |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} OpenCore() ** |
| - | ==== Parameters ==== | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetHorizontalResolution() === | + | * //This protected virtual method is called from the concreate public method Open. The open method play 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 source, 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.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Single | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:None |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === GetImage(RectangleShape,Int32,Int32) === | + | ** {{wiki:ProtectedMethod.gif|}} CloseCore() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //This method opens the ImageSource so that it is initialized and ready to use.// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | == Remarks == |
| - | * **Description**:N/A | + | * //This protected virtual method is called from the concreate 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. It is recommended that if you override this method that you take the following things into account. This method may be called multiple times so we suggest you write the so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the close you free all resources that have been opened. Remember that the object will not be destroyed but will be re-opened possibly in the near future. This API will only take effect when the suppressClose are set to false.// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **worldExtent** | + | * Type:Void |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | * Description:None |
| - | * **Description**:N/A | + | |
| - | **canvasWidth** | + | == Parameters == |
| - | * **Type**:Int32 | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() ** |
| - | **canvasHeight** | + | * //This method returns the projection text in proj4 format.// |
| - | * **Type**:Int32 | + | == Remarks == |
| - | * **Description**:N/A | + | * //This protected virtual method is called from the concrete public method GetProjectionText.The default implementation of this core method is to load the projection information from the ECW file and return the projection information in proj4 projection string format.// |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === GetImageHeight() === | + | * Type:String |
| - | N/A | + | * Description:Projection text string. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | <div newline></div> |
| - | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** |
| - | ==== Parameters ==== | + | * //This method returns an image based on the worldExtent and image width and height.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetImageWidth() === | + | * //This method is responsible for returning the image based on the parameters passed in.// |
| - | N/A | + | |
| - | ==== 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 and image width and height. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //worldExtent// |
| - | === GetProjectionText() === | + | * 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**:String | + | * 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 |
| - | === GetType() === | + | * 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**:Type | + | ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //This method returns the bounding box of the RasterSource.// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetVerticalResolution() === | + | * //This method returns the bounding box of the RasterSource.// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Single | + | * 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> |
| - | === GetWorldFileText() === | + | ** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:String | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | === Open() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //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) ** |
| - | === ToString() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:String | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Void |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | === CloneDeepCore() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] | + | * //e// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** |
| - | === CloseCore() === | + | |
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | |
| - | ==== Remarks ==== | + | |
| - | This protected virtual method is called from the concreate 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. It is recommended that if you override this method that you take the following things into account. This method may be called multiple times so we suggest you write the so that that a call to a closed FeatureSource is ignored and does not generate an error. We also suggest that in the close you free all resources that have been opened. Remember that the object will not be destroyed but will be re-opened possibly in the near future. This API will only take effect when the suppressClose are set to false. | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | === Finalize() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Void | + | * //e// |
| - | * **Description**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | [[#Protected Methods|Go Back]] | + | ** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** |
| - | === GetBoundingBoxCore() === | + | |
| - | This method returns the bounding box of the RasterSource. | + | |
| - | ==== Remarks ==== | + | |
| - | This method returns the bounding box of the RasterSource. | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | + | == Remarks == |
| - | * **Description**:This method returns the bounding box of the RasterSource. | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | === GetImageCore(RectangleShape,Int32,Int32) === | + | * Description:N/A |
| - | This method returns an image based on the worldExtent and image width and height. | + | |
| - | ==== Remarks ==== | + | |
| - | This method is responsible for returning the image based on the parameters passed in. | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | + | * //e// |
| - | * **Description**:This method returns an image based on the worldExtent and image width and height. | + | * Type:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
| + | * Description:N/A | ||
| - | ==== 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. | + | |
| - | **canvasWidth** | + | * //N/A// |
| - | * **Type**:Int32 | + | == Remarks == |
| - | * **Description**:This parameter represents the width of the image you want to draw. | + | * //N/A// |
| - | **canvasHeight** | + | == Return Value == |
| - | * **Type**:Int32 | + | * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] |
| - | * **Description**:This parameter represents the height of the image you want to draw. | + | * Description:N/A |
| - | [[#Protected Methods|Go Back]] | + | == Parameters == |
| - | === GetImageHeightCore() === | + | <div newline></div> |
| - | This method returns the height of the image in screen coordinates. | + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** |
| - | ==== Remarks ==== | + | |
| - | This method returns the height of the image in screen coordinates. | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Int32 | + | == Remarks == |
| - | * **Description**:This method returns the height of the image in screen coordinates. | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | === GetImageWidthCore() === | + | * Description: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** | + | == Parameters == |
| - | * **Return Type**:Int32 | + | * //boundingBox// |
| - | * **Description**:This method returns the width of the image in screen coordinates. | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| + | * Description:N/A | ||
| - | ==== Parameters ==== | + | * //screenWidth// |
| - | [[#Protected Methods|Go Back]] | + | * Type:Double |
| - | === GetProjectionTextCore() === | + | * Description:N/A |
| - | This method returns the projection text in proj4 format. | + | |
| - | ==== Remarks ==== | + | |
| - | This protected virtual method is called from the concrete public method GetProjectionText.The default implementation of this core method is to load the projection information from the ECW file and return the projection information in proj4 projection string format. | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:String | + | * Type:Double |
| - | * **Description**:Projection text string. | + | * Description:N/A |
| - | ==== Parameters ==== | + | * //wrappingExtent// |
| - | [[#Protected Methods|Go Back]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | === MemberwiseClone() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Object | + | ** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | === OnClosedRasterSource(ClosedRasterSourceEventArgs) === | + | * //N/A// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Void | + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **e** | + | * //boundingBox// |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Description**:N/A | + | * Description:N/A |
| - | [[#Protected Methods|Go Back]] | + | * //screenWidth// |
| - | === OnClosingRasterSource(ClosingRasterSourceEventArgs) === | + | * Type:Double |
| - | N/A | + | * Description:N/A |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //screenHeight// |
| - | * **Return Type**:Void | + | * Type:Double |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | * //wrappingExtent// |
| - | **e** | + | * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | === OnOpenedRasterSource(OpenedRasterSourceEventArgs) === | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **e** | + | * Type:Void |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | == Parameters == |
| - | === OnOpeningRasterSource(OpeningRasterSourceEventArgs) === | + | <div newline></div> |
| - | N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **e** | + | * Type:Object |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | * Description:N/A |
| - | * **Description**:N/A | + | |
| - | [[#Protected Methods|Go Back]] | + | == Parameters == |
| - | === OpenCore() === | + | <div newline></div> |
| - | This method opens the ImageSource so that it is initialized and ready to use. | + | ==== Public Properties ==== |
| - | ==== Remarks ==== | + | ** {{wiki:PublicProperty.gif|}} PathFilename ** |
| - | This protected virtual method is called from the concreate public method Open. The open method play 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 source, 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 or sets the file name and path of the MrSid image you are working with. |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:None | + | If you wish to change the file the class is working with you would want to change it here. You cannot change the file you are working with while the class is in an open state. |
| + | == Return Value == | ||
| + | * Type:String | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} SuppressClose ** | ||
| + | |||
| + | Gets or sets the SuppressClose property. | ||
| + | == Remarks == | ||
| + | If set the SuppressClose to ture, then the RasterSource will not be closed even you call the Close API. | ||
| + | == Return Value == | ||
| + | * Type:Boolean | ||
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} Projection ** | ||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === BlueTranslation === | ||
| 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]] | ||
| - | === GreenTranslation === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} BlueTranslation ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === HasProjectionText === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} RedTranslation ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === IsGrayscale === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} GreenTranslation ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === IsNegative === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Single |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsNegative ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === IsOpen === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} IsGrayscale ** |
| - | === PathFilename === | + | |
| - | This property gets or sets the file name and path of the MrSid image you are working with. | + | |
| - | ==== Remarks ==== | + | |
| - | If you wish to change the file the class is working with you would want to change it here. You cannot change the file you are working with while the class is in an open state. | + | |
| - | ==== 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:Boolean |
| + | |||
| + | ** {{wiki:PublicProperty.gif|}} IsOpen ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | === RedTranslation === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Boolean |
| - | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} HasProjectionText ** |
| - | === SuppressClose === | + | |
| - | Gets or sets the SuppressClose property. | + | |
| - | ==== Remarks ==== | + | |
| - | If set the SuppressClose to ture, then the RasterSource will not be closed even you call the Close API. | + | |
| - | ==== Return Value ==== | + | |
| - | **Return Type**:Boolean | + | |
| - | [[#Public Properties|Go Back]] | ||
| - | === Transparency === | ||
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Single | + | * Type:Boolean |
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ** {{wiki:ProtectedProperty.gif|}} HasProjectionTextCore ** | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | === HasProjectionTextCore === | ||
| This property returns true if the RasterSource has projection text, false if it does not. | This property returns true if the RasterSource has projection text, false if it does not. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| This protected virtual method is called from the concrete public property HasProjectionText. Thus, if you inherit RasterSource, please ensure that you override this virtual property to return the correct projection status of your raster source.We will check the HasProjectionText status before you call the GetProjectionText method. It will throw an exception if the HasProjectionText property returns false. | This protected virtual method is called from the concrete public property HasProjectionText. Thus, if you inherit RasterSource, please ensure that you override this virtual property to return the correct projection status of your raster source.We will check the HasProjectionText status before you call the GetProjectionText method. It will throw an exception if the HasProjectionText property returns false. | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:Boolean | + | * Type:Boolean |
| - | [[#Protected Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Public Events ===== | + | ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** |
| - | === ClosedRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** |
| - | === ClosingRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** |
| - | === OpenedRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | + | ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** |
| - | === OpeningRasterSource === | + | |
| N/A | N/A | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] | + | Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] |
| - | [[#Public Events|Go Back]] | ||
thinkgeo.mapsuite.core.mrsidrastersource.1442486106.txt.gz · Last modified: 2015/09/17 10:35 by admin