ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.AdornmentLayer ======
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**
        *[[ThinkGeo.MapSuite.Core.GraticuleAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.KmlAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.LegendAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.LogoAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.MagneticDeclinationAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer]]
        *[[ThinkGeo.MapSuite.Core.ScaleLineAdornmentLayer]]
===== Members Summary =====
==== Public Constructors ====
==== Protected Constructors ====
** {{wiki:ProtectedMethod.gif|}} AdornmentLayer() **

This method is the default constructor for the AdornmentLayer.
== Remarks ==
None
== Parameters ==
<div newline></div>
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} GetDrawingLocation(GeoCanvas,Single,Single) **

This method returns the drawing location of the AdornmentLayer.
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]]
  * Description:It returns the upper left screen point of where the AdornmentLayer will be drawn.

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|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

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]]
  * 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|}} GetBoundingBox() **

N/A
== Remarks ==
N/A

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

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) **

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

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

N/A
== Remarks ==
N/A

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

== Parameters ==
<div newline></div>
** {{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

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //extentsToRefresh//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
    * Description:N/A

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

N/A
== Remarks ==
N/A

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

== Parameters ==
  * //bufferTime//
    * Type:TimeSpan
    * Description:N/A

<div newline></div>
** {{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

<div newline></div>
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,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

<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|}} 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:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter is the canvas object (or a GeoImage) to draw on.

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:This parameter represents the labels used for collision detection and duplication checking.

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

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

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

N/A
== Remarks ==
N/A

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

== Parameters ==
<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<div newline></div>
** {{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

<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|}} Width **

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

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

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

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

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

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

This property gets and sets the drawing location of the AdornmentLayer.
== Remarks ==
N/A
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]]

** {{wiki:PublicProperty.gif|}} 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

** {{wiki:PublicProperty.gif|}} 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

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

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

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

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|}} 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|}} 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]]

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

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

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

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

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

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

** {{wiki:ProtectedProperty.gif|}} IsOpenCore **

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

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

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

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

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

** {{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]]

** {{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]]
Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo

User Tools

Site Tools

Page Tools

Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo
