====== ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay ======
{{section>upgrade_map_suite_to_10.0}}
===== Inheritance Hierarchy =====
*System.Object
*ThinkGeo.MapSuite.AndroidEdition.Overlay
***ThinkGeo.MapSuite.AndroidEdition.AdornmentOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} AdornmentOverlay() **
* //Initializes a new instance of the class.//
== Remarks ==
* //N/A//
== Parameters ==
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} Refresh(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|}} Refresh(TimeSpan) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(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|}} Refresh(TimeSpan,BufferTimeType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.MapSuite.Core.BufferTimeType|BufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(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|}} Refresh(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|}} Refresh(RectangleShape,TimeSpan,BufferTimeType) **
* //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.BufferTimeType|BufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(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|}} Refresh(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|}} Refresh(IEnumerable,TimeSpan,BufferTimeType) **
* //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.BufferTimeType|BufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Draw(MapArguments,OverlayRefreshType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:N/A
* //refreshType//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} PostTransform(TransformArguments,MapArguments) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //transformInfo//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]]
* Description:N/A
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Close() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Open() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Dispose() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{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|}} InitializeCore(MapArguments) **
* //This method initializes overlay object.//
== Remarks ==
* //When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:This parameter maintains current map information for calculating mechanism.
** {{wiki:ProtectedMethod.gif|}} DrawCore(MapArguments,OverlayRefreshType) **
* //This method draws the overlay with the provided extent in world coordinate.//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:This parameter maintains current map information for calculating mechanism.
* //refreshType//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType|OverlayRefreshType]]
* Description:This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode.
** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) **
* //Releases unmanaged and - optionally - managed resources.//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //disposing//
* Type:Boolean
* Description:true to release both managed and unmanaged resources; false to release only unmanaged resources.
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} RefreshCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extent//
* Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} PostTransformCore(TransformArguments,MapArguments) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //transformInfo//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.TransformArguments|TransformArguments]]
* Description:N/A
* //mapArguments//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} CloseCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //geoCanvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
* //exception//
* Type:Exception
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //geoCanvas//
* Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
* //ex//
* Type:Exception
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]
* 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|}} ShowLogo **
* //Gets or sets a value indicating whether [show logo].//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} IsEmpty **
* //This property indicates whether this overlay is empty or not.//
== Remarks ==
* //This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} Layers **
* //This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoCollection[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuitePortableCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection]]
** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
* //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|}} DrawingExceptionMode **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
** {{wiki:PublicProperty.gif|}} IsVisible **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} Attribution **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} OverlayView **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapLayout|MapLayout]]
** {{wiki:PublicProperty.gif|}} DrawingQuality **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingQuality|DrawingQuality]]
** {{wiki:PublicProperty.gif|}} Opacity **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Double
** {{wiki:PublicProperty.gif|}} MapArguments **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.AndroidEdition.MapArguments|MapArguments]]
** {{wiki:PublicProperty.gif|}} CanRefreshRegion **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
==== Protected Properties ====
==== Public Events ====
** {{wiki:PublicEvent.gif|}} DrawingException **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs|DrawingExceptionOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} DrawnException **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs|DrawnExceptionOverlayEventArgs]]