====== ThinkGeo.MapSuite.Core.MrSidRasterLayer ====== {{section>upgrade_map_suite_to_10.0}} This class represents a MrSid image to be drawn on the map. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Core.Layer *ThinkGeo.MapSuite.Core.RasterLayer ***ThinkGeo.MapSuite.Core.MrSidRasterLayer** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} MrSidRasterLayer() ** This is a constructor for the class. == Remarks == If you use this constructor then, you need to set the PathFileName property manually before using the layer. == Parameters ==
** {{wiki:PublicMethod.gif|}} MrSidRasterLayer(String) ** This is a constructor for the class. == Remarks == This constructor gets the layer ready to use. == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and filename of the MrSid file you want to use.
** {{wiki:PublicMethod.gif|}} MrSidRasterLayer(String,String) ** This is a constructor for the class. == Remarks == This constructor gets the layer ready to use. == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and filename of the MrSid image file you want to use. * //worldFilePathFilename// * Type:String * Description:This parameter is the world file path and filename for the MrSid image you want to use.
** {{wiki:PublicMethod.gif|}} MrSidRasterLayer(String,RectangleShape) ** This is a constructor for the class. == Remarks == This constructor gets the layer ready to use. == Parameters == * //imagePathFilename// * Type:String * Description:This parameter is the path and filename of the MrSid image file you want to use. * //imageExtent// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:This parameter is the image extent of the MrSid image file you want to use.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} Dispose() ** Release the unmanage resource in RasterSource. == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetProjectionText() ** N/A == Remarks == N/A == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** N/A == Remarks == N/A == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** N/A == Remarks == N/A == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} CloneDeep() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** N/A == Remarks == N/A == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** N/A == Remarks == N/A == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** N/A == Remarks == N/A == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** N/A == Remarks == N/A == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //attribution// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** N/A == Remarks == N/A == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** N/A == Remarks == N/A == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} PathFilename ** This property gets and sets the path and filename of the MrSid file you want to use. == Remarks == This should be a complete path and filename for the MrSid file. == 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|}} HasBoundingBox ** This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. In mrSidRasterLayer, we override this API and mark it as true. == Remarks == The default implementation in the base class returns false. == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ImageSource ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]] ** {{wiki:PublicProperty.gif|}} UpperThreshold ** N/A == Remarks == N/A == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} LowerThreshold ** N/A == Remarks == N/A == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} HasProjectionText ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** N/A == Remarks == N/A == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} IsOpen ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} DrawingTime ** N/A == Remarks == N/A == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Name ** N/A == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Attribution ** N/A == Remarks == N/A == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} IsVisible ** N/A == Remarks == N/A == Return Value == * Type:Boolean ** {{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|}} KeyColors ** N/A == Remarks == N/A == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]> ** {{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|}} DrawingExceptionMode ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** N/A == Remarks == N/A == Return Value == * Type:Boolean ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingException ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnException ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** N/A == Remarks == N/A Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]