Table of Contents

ThinkGeo.MapSuite.Core.AdornmentLayer
- Inheritance Hierarchy
- Members Summary

ThinkGeo.MapSuite.Core.AdornmentLayer

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

This is the base class of AdornmentLayers. The AdornmentLayer is used to place adornments on the map. Two types of AdornmentLayers are provided: ScaleLineAdornmentLayer and ScaleBarAdornmentLayer.

Inheritance Hierarchy

System.Object
- ThinkGeo.MapSuite.Core.Layer
  - ThinkGeo.MapSuite.Core.AdornmentLayer

Members Summary

Public Constructors

Protected Constructors

AdornmentLayer()

This method is the default constructor for the AdornmentLayer.

Remarks

None

Parameters

Public Methods

GetDrawingLocation(GeoCanvas,Single,Single)

This method returns the drawing location of the AdornmentLayer.

Remarks

N/A

Return Value

Type:ScreenPointF
Description:It returns the upper left screen point of where the AdornmentLayer will be drawn.

Parameters

canvas
- Type:GeoCanvas
- Description:This parameter is the canvas used in drawing.

adornmentWidth
- Type:Single
- Description:This parameter is the width of the adornment.

adornmentHeight
- Type:Single
- Description:This parameter is the height of the adornment

GetThreadSafetyLevel()

N/A

Remarks

N/A

Return Value

Type:ThreadSafetyLevel
Description:N/A

Parameters

CloneDeep()

N/A

Remarks

N/A

Return Value

Type:Layer
Description:N/A

Parameters

Open()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

Close()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

GetBoundingBox()

N/A

Remarks

N/A

Return Value

Type:RectangleShape
Description:N/A

Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:N/A

RequestDrawing()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

RequestDrawing(RectangleShape)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

extentToRefresh
- Type:RectangleShape
- Description:N/A

RequestDrawing(IEnumerable<RectangleShape>)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A

RequestDrawing(TimeSpan)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

bufferTime
- Type:TimeSpan
- Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

extentToRefresh
- Type:RectangleShape
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A

bufferTime
- Type:TimeSpan
- Description:N/A

ToString()

N/A

Remarks

N/A

Return Value

Type:String
Description:N/A

Parameters

Equals(Object)

N/A

Remarks

N/A

Return Value

Type:Boolean
Description:N/A

Parameters

obj
- Type:Object
- Description:N/A

GetHashCode()

N/A

Remarks

N/A

Return Value

Type:Int32
Description:N/A

Parameters

GetType()

N/A

Remarks

N/A

Return Value

Type:Type
Description:N/A

Parameters

Protected Methods

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

This method draws the AdornmentLayer.

Remarks

This virtual method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided. You can use the full power of the GeoCanvas to do the drawing.

Return Value

Type:Void
Description:None

Parameters

canvas
- Type:GeoCanvas
- Description:This parameter is the canvas object (or a GeoImage) to draw on.

labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:This parameter represents the labels used for collision detection and duplication checking.

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

eventArgs
- Type:RequestingDrawingLayerEventArgs
- Description:N/A

GetThreadSafetyLevelCore()

N/A

Remarks

N/A

Return Value

Type:ThreadSafetyLevel
Description:N/A

Parameters

CloneDeepCore()

N/A

Remarks

N/A

Return Value

Type:Layer
Description:N/A

Parameters

OpenCore()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

CloseCore()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

GetBoundingBoxCore()

N/A

Remarks

N/A

Return Value

Type:RectangleShape
Description:N/A

Parameters

DrawException(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

e
- Type:Exception
- Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

e
- Type:Exception
- Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

e
- Type:DrawingExceptionLayerEventArgs
- Description:N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

e
- Type:DrawnExceptionLayerEventArgs
- Description:N/A

DrawAttributionCore(GeoCanvas,String)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

canvas
- Type:GeoCanvas
- Description:N/A

attribution
- Type:String
- Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

args
- Type:DrawingAttributionLayerEventArgs
- Description:N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

args
- Type:DrawnAttributionLayerEventArgs
- Description:N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

e
- Type:DrawingProgressChangedEventArgs
- Description:N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

eventArgs
- Type:RequestedDrawingLayerEventArgs
- Description:N/A

Finalize()

N/A

Remarks

N/A

Return Value

Type:Void
Description:N/A

Parameters

MemberwiseClone()

N/A

Remarks

N/A

Return Value

Type:Object
Description:N/A

Parameters

Public Properties

Width

N/A

Remarks

N/A

Return Value

Type:Single

Height

N/A

Remarks

N/A

Return Value

Type:Single

BackgroundMask

N/A

Remarks

N/A

Return Value

Type:AreaStyle

Location

This property gets and sets the drawing location of the AdornmentLayer.

Remarks

N/A

Return Value

Type:AdornmentLocation

XOffsetInPixel

This property gets and sets the X pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment.

Return Value

Type:Single

YOffsetInPixel

This property gets and sets the Y pixel offset for the AdornmentLayer.

Remarks

This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment.

Return Value

Type:Single

IsOpen

N/A

Remarks

N/A

Return Value

Type:Boolean

HasBoundingBox

N/A

Remarks

N/A

Return Value

Type:Boolean

DrawingTime

N/A

Remarks

N/A

Return Value

Type:TimeSpan

Name

N/A

Remarks

N/A

Return Value

Type:String

IsVisible

N/A

Remarks

N/A

Return Value

Type:Boolean

Transparency

N/A

Remarks

N/A

Return Value

Type:Single

IsNegative

N/A

Remarks

N/A

Return Value

Type:Boolean

IsGrayscale

N/A

Remarks

N/A

Return Value

Type:Boolean

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

Type:DrawingExceptionMode

Attribution

N/A

Remarks

N/A

Return Value

Type:String

RequestDrawingInterval

N/A

Remarks

N/A

Return Value

Type:TimeSpan

Protected Properties

ActualWidth

N/A

Remarks

N/A

Return Value

Type:Single

IsOpenCore

N/A

Remarks

N/A

Return Value

Type:Boolean

Public Events

DrawingException

N/A

Remarks

N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawingProgressChanged

N/A

Remarks

N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution

N/A

Remarks

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution

N/A

Remarks

N/A

Event Arguments:DrawnAttributionLayerEventArgs

RequestedDrawing

N/A

Remarks

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing

N/A

Remarks

N/A

Event Arguments:RequestingDrawingLayerEventArgs