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.WpfDesktopEdition.AdornmentOverlay ======



This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.
=== Remarks ===
<html>
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay</a>
</html>
===== Inheritance Hierarchy =====
  *System.Object
    *[[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay]]
      *[[ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#AdornmentOverlay()|AdornmentOverlay]]   |    |    | Constructor of AdornmentOverlay class.   |

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Dispose()|Dispose]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method dispose unmanaged resource used in this class.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Draw(RectangleShape)|Draw]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method draws the overlay with the provided extent in world coordinate.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Draw(RectangleShape, OverlayRefreshType)|Draw]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method draws the overlay with the provided extent in world coordinate.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method gets a bounding box of the Overlay.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Initialize(MapArguments)|Initialize]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method initializes overlay object.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#LoadState(Byte［］)|LoadState]]   | Byte［］   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method restore the overlay state back from the specified state.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#PanTo(RectangleShape)|PanTo]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method pans the overlay to the provided world extent.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(IEnumerable<RectangleShape>)|Refresh]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(TimeSpan)|Refresh]]   | TimeSpan   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(TimeSpan, RequestDrawingBufferTimeType)|Refresh]]   | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(RectangleShape, TimeSpan)|Refresh]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)|Refresh]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(RectangleShape)|Refresh]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(IEnumerable<RectangleShape>, TimeSpan)|Refresh]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh()|Refresh]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)|Refresh]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#SaveState()|SaveState]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method saves overlay state to a byte array.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |

==== Protected Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Dispose(Boolean)|Dispose]]   | Boolean   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]](overriden)   | This method disposes the unmanaged resource used in this overlay.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas)|DrawAttributionCore]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(RectangleShape, OverlayRefreshType)|DrawCore]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], [[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]](overriden)   | This method override the DrawCore logic of the Overlay class.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object(overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method returns the bounding box of the Overlay.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#InitializeCore(MapArguments)|InitializeCore]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method initializes overlay object.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadStateCore(Byte［］)|LoadStateCore]]   | Byte［］   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]](overriden)   | This method restore the overlay state back from the specified state.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawing(DrawingOverlayEventArgs)|OnDrawing]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method raises before the overlay is drawing.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionOverlayEventArgs)|OnDrawingAttribution]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawn(DrawnOverlayEventArgs)|OnDrawn]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method raises after the overlay is drawn.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionOverlayEventArgs)|OnDrawnAttribution]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#PanToCore(RectangleShape)|PanToCore]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method pans the overlay to the provided world extent.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RefreshCore()|RefreshCore]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RefreshCore(RectangleShape)|RefreshCore]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#SaveStateCore()|SaveStateCore]]   |    | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]](overriden)   | This method saves overlay state to a byte array.   |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]]   | String   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]]   | TimeSpan   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#CanRefreshRegion|CanRefreshRegion]]   | Boolean   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]]   | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsBase|IsBase]]   | Boolean   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsEmpty|IsEmpty]]   | Boolean   |    |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets if this overlay is visible.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Layers|Layers]]   | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]>   |    | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#MapArguments|MapArguments]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets current map information which will be used for calculating mechanism.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets the name of this overaly.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#OverlayCanvas|OverlayCanvas]]   | Canvas   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets the actual canvas which maintains all the visual elements on the overlay.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#ShowLogo|ShowLogo]]   | Boolean   |    | This property is a easy way to add the LogoAdornmentLayer to the AdormentOverlay.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOverlayInitialized|IsOverlayInitialized]]   | Boolean   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets if the overlay canvas is initialized.   |
| {{wiki:ProtectedProperty.gif|Protected Property}}[[#PreviousExtent|PreviousExtent]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | Gets or sets the previous exent of the overlay.   |

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
| {{wiki:PublicEvent.gif|Public Event}}[[#Drawing|Drawing]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This event raises before the overlay is drawing.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |
| {{wiki:PublicEvent.gif|Public Event}}[[#Drawn|Drawn]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   | This event raises after the overlay is drawn.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]   | [[ThinkGeo.MapSuite.WpfDesktopEdition.Overlay|Overlay]]   |    |

===== Public Constructors =====
==== AdornmentOverlay() ====
Constructor of AdornmentOverlay class.
=== Remarks ===
<html>
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AdornmentOverlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AdornmentOverlay.28.29</a>
</html>
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Public Constructors|Go Back]]
===== Protected Constructors =====
===== Public Methods =====
==== Close() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Close.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Close.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Dispose() ====
This method dispose unmanaged resource used in this class.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Dispose.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Dispose.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Draw(RectangleShape) ====
This method draws the overlay with the provided extent in world coordinate.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Draw.28RectangleShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Draw.28RectangleShape.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| targetExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter indicates an extent in world coordinate for drawing the overlay.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Draw(RectangleShape, OverlayRefreshType) ====
This method draws the overlay with the provided extent in world coordinate.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Draw.28RectangleShape.2C_OverlayRefreshType.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Draw.28RectangleShape.2C_OverlayRefreshType.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| targetExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter indicates an extent in world coordinate for drawing the overlay.   |
| refreshType   | [[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType -->   | 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.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Equals(Object) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Equals.28Object.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Boolean<!-- System.Boolean -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object<!-- System.Object -->   |    |

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetBoundingBox() ====
This method gets a bounding box of the Overlay.
=== Remarks ===
This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay.As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | A RectangleShape indicating the bounding box of this overlay   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetHashCode.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetType() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#GetType.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Type<!-- System.Type -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== Initialize(MapArguments) ====
This method initializes overlay object.
=== Remarks ===
This is a wrapper method for the virtual method InitializeCore.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| mapArguments   | [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments -->   | This parameter maintains current map information for calculating mechanism.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== LoadState(Byte［］) ====
This method restore the overlay state back from the specified state.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| state   | Byte［］<!-- System.Byte[[]] -->   | This parameter indicates the state for restore the overlay.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Open() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Open.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Open.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== PanTo(RectangleShape) ====
This method pans the overlay to the provided world extent.
=== Remarks ===
Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| targetExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter is the target world extent for panning.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(IEnumerable<RectangleShape>) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(TimeSpan) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28TimeSpan.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28TimeSpan.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(TimeSpan, RequestDrawingBufferTimeType) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(RectangleShape, TimeSpan) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.2C_TimeSpan.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.2C_TimeSpan.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extentToRefresh   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(RectangleShape) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Refresh.28RectangleShape.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(IEnumerable<RectangleShape>, TimeSpan) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh() ====
This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.
=== Remarks ===
The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== Refresh(RectangleShape, TimeSpan, RequestDrawingBufferTimeType) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extentToRefresh   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== SaveState() ====
This method saves overlay state to a byte array.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#SaveState.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#SaveState.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Byte［］<!-- System.Byte[[]] -->   | A byte array indicates current overlay state.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Methods|Go Back]]
==== ToString() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ToString.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
===== Protected Methods =====
==== CloseCore() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CloseCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CloseCore.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== Dispose(Boolean) ====
This method disposes the unmanaged resource used in this overlay.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Dispose.28Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Dispose.28Boolean.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| disposing   | Boolean<!-- System.Boolean -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) -->
[[#Protected Methods|Go Back]]
==== DrawAttributionCore(GeoCanvas) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== DrawCore(RectangleShape, OverlayRefreshType) ====
This method override the DrawCore logic of the Overlay class.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawCore.28RectangleShape.2C_OverlayRefreshType.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawCore.28RectangleShape.2C_OverlayRefreshType.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| targetExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter specifies the extent for drawing this overlay.   |
| overlayRefreshType   | [[ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType|OverlayRefreshType]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType -->   | This parameter specifies whether this overlay need to be clear and refresh or not.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) -->
[[#Protected Methods|Go Back]]
==== Finalize() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Finalize.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object(overriden) -->
[[#Protected Methods|Go Back]]
==== GetBoundingBoxCore() ====
This method returns the bounding box of the Overlay.
=== Remarks ===
This method returns the bounding box of the Overlay.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the Overlay.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== 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 ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| mapArguments   | [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments -->   | This parameter maintains current map information for calculating mechanism.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== LoadStateCore(Byte［］) ====
This method restore the overlay state back from the specified state.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="" target="_blank"></a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| state   | Byte［］<!-- System.Byte[[]] -->   | This parameter indicates the state for restore the overlay.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) -->
[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#MemberwiseClone.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== OnDrawing(DrawingOverlayEventArgs) ====
This method raises before the overlay is drawing.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs -->   | This parameter is the event argument for Drawing event.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== OnDrawingAttribution(DrawingAttributionOverlayEventArgs) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| args   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== OnDrawn(DrawnOverlayEventArgs) ====
This method raises after the overlay is drawn.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs -->   | This parameter is the event argument for Drawn event.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== OnDrawnAttribution(DrawnAttributionOverlayEventArgs) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| args   | [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== OpenCore() ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OpenCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OpenCore.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== PanToCore(RectangleShape) ====
This method pans the overlay to the provided world extent.
=== Remarks ===
Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| targetExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter is the target world extent for panning.   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== RefreshCore() ====
This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.
=== Remarks ===
The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== RefreshCore(RectangleShape) ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#RefreshCore.28RectangleShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#RefreshCore.28RectangleShape.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| extent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Methods|Go Back]]
==== SaveStateCore() ====
This method saves overlay state to a byte array.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#SaveStateCore.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#SaveStateCore.28.29</a>
=== Return Value ===
^ Return Type ^ Description ^
| Byte［］<!-- System.Byte[[]] -->   | A byte array indicates current overlay state.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== Attribution ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawAttributionCore.28GeoCanvas.29</a>
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== AutoRefreshInterval ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AutoRefreshInterval" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AutoRefreshInterval</a>
=== Return Value ===
^ Return Type ^
| TimeSpan<!-- System.TimeSpan -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== CanRefreshRegion ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CanRefreshRegion" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#CanRefreshRegion</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== DrawingExceptionMode ====
This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawingExceptionMode" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#DrawingExceptionMode</a>
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== IsBase ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsBase" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsBase</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== IsEmpty ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsEmpty" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsEmpty</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay -->
[[#Public Properties|Go Back]]
==== IsVisible ====
Gets or sets if this overlay is visible.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsVisible</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== Layers ====
This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Layers" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Layers</a>
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]><!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay -->
[[#Public Properties|Go Back]]
==== MapArguments ====
Gets or sets current map information which will be used for calculating mechanism.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Initialize.28MapArguments.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Initialize.28MapArguments.29</a>
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments|MapArguments]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== Name ====
Gets or sets the name of this overaly.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#Name</a>
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== OverlayCanvas ====
Gets or sets the actual canvas which maintains all the visual elements on the overlay.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OverlayCanvas" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OverlayCanvas</a>
=== Return Value ===
^ Return Type ^
| Canvas<!-- System.Windows.Controls.Canvas -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Properties|Go Back]]
==== ShowLogo ====
This property is a easy way to add the LogoAdornmentLayer to the AdormentOverlay.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ShowLogo" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#ShowLogo</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
==== IsOverlayInitialized ====
Gets or sets if the overlay canvas is initialized.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsOverlayInitialized" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#IsOverlayInitialized</a>
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Properties|Go Back]]
==== PreviousExtent ====
Gets or sets the previous exent of the overlay.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#PreviousExtent" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#PreviousExtent</a>
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Protected Properties|Go Back]]
===== Public Events =====
==== Drawing ====
This event raises before the overlay is drawing.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawing.28DrawingOverlayEventArgs.29</a>
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Events|Go Back]]
==== DrawingAttribution ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a>
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Events|Go Back]]
==== Drawn ====
This event raises after the overlay is drawn.
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawn.28DrawnOverlayEventArgs.29</a>
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Events|Go Back]]
==== DrawnAttribution ====
=== Remarks ===
For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a>
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs -->   |

<!-- ThinkGeo.MapSuite.WpfDesktopEdition.Overlay -->
[[#Public Events|Go Back]]

__NOTOC__
[[Category:WpfDesktopEdition]]
[[Category:ThinkGeo.MapSuite.WpfDesktopEdition]]
[[Category:UpdateDocumentation]]
User Tools

Site Tools

Page Tools
