====== ThinkGeo.MapSuite.Core.MrSidRasterSource ======

{{section>upgrade_map_suite_to_10.0}}

This class represents the MrSid raster source.
===== Inheritance Hierarchy =====
  *System.Object
    *ThinkGeo.MapSuite.Core.RasterSource
      ***ThinkGeo.MapSuite.Core.MrSidRasterSource**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} MrSidRasterSource() **

This is the constructor for the class.
== Remarks ==
N/A
== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} 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.

<div newline></div>
** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,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 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//
    * Type:String
    * Description:This parameter represents the world file path and file name of the MrSid file you want to use

<div newline></div>
** {{wiki:PublicMethod.gif|}} MrSidRasterSource(String,RectangleShape) **

This is a constructor for the class.
== 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//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:This parameter is the image extent of sid source you want to use.

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} Dispose() **

Release the unmanage resource by setting the rasterImage to null.
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} CloneDeep() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetWorldFileText() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetImageWidth() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetImageHeight() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Single
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Single
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetBoundingBox() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetProjectionText() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Open() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Close() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
  * Description:N/A

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:N/A

  * //canvasWidth//
    * Type:Int32
    * Description:N/A

  * //canvasHeight//
    * Type:Int32
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() **

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 ==
  * Type:Int32
  * Description:This method returns the width of the image in screen coordinates.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() **

This method returns the height of the image in screen coordinates.
== Remarks ==
This method returns the height of the image in screen coordinates.

== Return Value ==
  * Type:Int32
  * Description:This method returns the height of the image in screen coordinates.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OpenCore() **

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 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 ==
  * Type:Void
  * Description:None

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
  * Type:Void
  * Description:None

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetProjectionTextCore() **

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 ==
  * Type:String
  * Description:Projection text string.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) **

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 ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]
  * Description:This method returns an image based on the worldExtent and image width and height.

== Parameters ==
  * //worldExtent//
    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
    * Description:This parameter represents the worldExtent you want to draw.

  * //canvasWidth//
    * Type:Int32
    * Description:This parameter represents the width of the image you want to draw.

  * //canvasHeight//
    * Type:Int32
    * Description:This parameter represents the height of the image you want to draw.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **

This method returns the bounding box of the RasterSource.
== Remarks ==
This method returns the bounding box of the RasterSource.

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
  * Description:This method returns the bounding box of the RasterSource.

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //e//
    * Type:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} 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 ==
  * 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 **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]]

** {{wiki:PublicProperty.gif|}} Transparency **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} BlueTranslation **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} RedTranslation **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} GreenTranslation **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Single

** {{wiki:PublicProperty.gif|}} IsNegative **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} IsGrayscale **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} IsOpen **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

** {{wiki:PublicProperty.gif|}} HasProjectionText **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Boolean

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} HasProjectionTextCore **

This property returns true if the RasterSource has projection text, false if it does not.
== 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.
== Return Value ==
  * Type:Boolean

==== Public Events ====
** {{wiki:PublicEvent.gif|}} OpeningRasterSource **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]

** {{wiki:PublicEvent.gif|}} OpenedRasterSource **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]

** {{wiki:PublicEvent.gif|}} ClosingRasterSource **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]

** {{wiki:PublicEvent.gif|}} ClosedRasterSource **
N/A
== Remarks ==
N/A

Event Arguments:[[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]