ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay
This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.
Remarks
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay
Inheritance Hierarchy
- System.Object
-
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 AdornmentOverlay | Constructor of AdornmentOverlay class. |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| Close | Overlay | ||
| Dispose | Overlay | This method dispose unmanaged resource used in this class. | |
| Draw | RectangleShape | Overlay | This method draws the overlay with the provided extent in world coordinate. |
| Draw | RectangleShape, OverlayRefreshType | Overlay | This method draws the overlay with the provided extent in world coordinate. |
| Equals | Object | Object | |
| GetBoundingBox | Overlay | This method gets a bounding box of the Overlay. | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Initialize | MapArguments | Overlay | This method initializes overlay object. |
| LoadState | Byte［］ | Overlay | This method restore the overlay state back from the specified state. |
| Open | Overlay | ||
| PanTo | RectangleShape | Overlay | This method pans the overlay to the provided world extent. |
| Refresh | IEnumerable<RectangleShape> | Overlay | |
| Refresh | TimeSpan | Overlay | |
| Refresh | TimeSpan, RequestDrawingBufferTimeType | Overlay | |
| Refresh | RectangleShape, TimeSpan | Overlay | |
| Refresh | IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType | Overlay | |
| Refresh | RectangleShape | Overlay | |
| Refresh | IEnumerable<RectangleShape>, TimeSpan | Overlay | |
| Refresh | 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. | |
| Refresh | RectangleShape, TimeSpan, RequestDrawingBufferTimeType | Overlay | |
| SaveState | Overlay | This method saves overlay state to a byte array. | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloseCore | Overlay | ||
| Dispose | Boolean | Overlay(overriden) | This method disposes the unmanaged resource used in this overlay. |
| DrawAttributionCore | GeoCanvas | Overlay | |
| DrawCore | RectangleShape, OverlayRefreshType | Overlay(overriden) | This method override the DrawCore logic of the Overlay class. |
| Finalize | Object(overriden) | ||
| GetBoundingBoxCore | Overlay | This method returns the bounding box of the Overlay. | |
| InitializeCore | MapArguments | Overlay | This method initializes overlay object. |
| LoadStateCore | Byte［］ | Overlay(overriden) | This method restore the overlay state back from the specified state. |
| MemberwiseClone | Object | ||
| OnDrawing | DrawingOverlayEventArgs | Overlay | This method raises before the overlay is drawing. |
| OnDrawingAttribution | DrawingAttributionOverlayEventArgs | Overlay | |
| OnDrawn | DrawnOverlayEventArgs | Overlay | This method raises after the overlay is drawn. |
| OnDrawnAttribution | DrawnAttributionOverlayEventArgs | Overlay | |
| OpenCore | Overlay | ||
| PanToCore | RectangleShape | Overlay | This method pans the overlay to the provided world extent. |
| RefreshCore | 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. | |
| RefreshCore | RectangleShape | Overlay | |
| SaveStateCore | Overlay(overriden) | This method saves overlay state to a byte array. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | Overlay | |
| AutoRefreshInterval | TimeSpan | Overlay | |
| CanRefreshRegion | Boolean | Overlay | |
| DrawingExceptionMode | DrawingExceptionMode | Overlay | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. |
| IsBase | Boolean | Overlay | |
| IsEmpty | Boolean | ||
| IsVisible | Boolean | Overlay | Gets or sets if this overlay is visible. |
| Layers | GeoCollection<AdornmentLayer> | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. | |
| MapArguments | MapArguments | Overlay | Gets or sets current map information which will be used for calculating mechanism. |
| Name | String | Overlay | Gets or sets the name of this overaly. |
| OverlayCanvas | Canvas | Overlay | Gets or sets the actual canvas which maintains all the visual elements on the overlay. |
| ShowLogo | Boolean | This property is a easy way to add the LogoAdornmentLayer to the AdormentOverlay. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 IsOverlayInitialized | Boolean | Overlay | Gets or sets if the overlay canvas is initialized. |
| PreviousExtent | RectangleShape | Overlay | Gets or sets the previous exent of the overlay. |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 Drawing | DrawingOverlayEventArgs | Overlay | This event raises before the overlay is drawing. |
| DrawingAttribution | DrawingAttributionOverlayEventArgs | Overlay | |
| Drawn | DrawnOverlayEventArgs | Overlay | This event raises after the overlay is drawn. |
| DrawnAttribution | DrawnAttributionOverlayEventArgs | Overlay |
Public Constructors
AdornmentOverlay()
Constructor of AdornmentOverlay class.
Remarks
For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay#AdornmentOverlay.28.29
Parameters
| Name | Type | Description |
|---|
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 –> 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 –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter indicates an extent in world coordinate for drawing the overlay. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter indicates an extent in world coordinate for drawing the overlay. |
| refreshType | 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 –> 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 –> 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 |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | A RectangleShape indicating the bounding box of this overlay |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 –> 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 | MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | This parameter indicates the state for restore the overlay. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter is the target world extent for panning. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> | |
| bufferTimeType | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> | |
| bufferTimeType | RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | A byte array indicates current overlay state. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 –> 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) –> 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 | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter specifies the extent for drawing this overlay. |
| 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) –> 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) –> 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 |
|---|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This method returns the bounding box of the Overlay. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –> | This parameter maintains current map information for calculating mechanism. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | This parameter indicates the state for restore the overlay. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) –> 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 –> 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 | DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs –> | This parameter is the event argument for Drawing event. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs –> | This parameter is the event argument for Drawn event. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 | DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | This parameter is the target world extent for panning. |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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.Bytethinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay –> | A byte array indicates current overlay state. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay(overriden) –> 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 –> 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 –> 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 –> 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 |
|---|
| DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 –> 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 –> 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 |
|---|
| GeoCollection<AdornmentLayer><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.AdornmentOverlay –> 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 |
|---|
| MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 –> 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 –> 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 –> 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 –> 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 |
|---|
| RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 |
|---|
| DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 |
|---|
| DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 |
|---|
| DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> 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 |
|---|
| DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.WpfDesktopEdition.Overlay –> Go Back
NOTOC WpfDesktopEdition ThinkGeo.MapSuite.WpfDesktopEdition UpdateDocumentation
thinkgeo.mapsuite.wpfdesktopedition.adornmentoverlay.1441684230.txt.gz · Last modified: 2015/09/08 03:50 by admin