ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.desktopedition.overlay
This is an old revision of the document!
Table of Contents
ThinkGeo.MapSuite.DesktopEdition.Overlay
<!– Class –> Serves as the base class that defines the properties and methods shared by all types of overlays.
Remarks
The <strong>Overlay</strong> has a similar concept to that of the Layer. Different types of overlays stack over each other to form a map.Usually, an overlay represents an image with a transparent background that is laid upon other overlay, such as a <strong>LayerOverlay</strong> or <strong>WmsOverlay</strong>.There are basically two kinds of overlays: base overlays and non-base overlays.A base overlay has its <strong>IsBase</strong> property set to true. It is displayed as the background image of the map.A non-base overlay has a false <strong>IsBase</strong> property. These overlays can overlap the base overlay and/or each other.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.DesktopEdition.Overlay *ThinkGeo.MapSuite.DesktopEdition.AdornmentOverlay *ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay *ThinkGeo.MapSuite.DesktopEdition.BingMapsOverlay *ThinkGeo.MapSuite.DesktopEdition.EditInteractiveOverlay *ThinkGeo.MapSuite.DesktopEdition.ExtentInteractiveOverlay *ThinkGeo.MapSuite.DesktopEdition.FeatureSourceMarkerOverlay *ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay *ThinkGeo.MapSuite.DesktopEdition.InMemoryMarkerOverlay *ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay *ThinkGeo.MapSuite.DesktopEdition.LayerOverlay *ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay *ThinkGeo.MapSuite.DesktopEdition.OpenStreetMapOverlay *ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay *ThinkGeo.MapSuite.DesktopEdition.SimpleMarkerOverlay *ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay *ThinkGeo.MapSuite.DesktopEdition.TrackInteractiveOverlay *ThinkGeo.MapSuite.DesktopEdition.WmtsOverlay ***ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Overlay | Initialize an instance of the Overlay class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 Draw | GeoCanvas | This method draws the Overlay. | |
| DrawPreview | GeoCanvas | This method will be used to draw preview tiles to the canvas. | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetType | Object | ||
| Refresh | GeoCanvas, RectangleShape | ||
| RequestDrawing | |||
| RequestDrawing | IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType | ||
| RequestDrawing | RectangleShape, TimeSpan, RequestDrawingBufferTimeType | ||
| RequestDrawing | RectangleShape, TimeSpan | ||
| RequestDrawing | TimeSpan, RequestDrawingBufferTimeType | ||
| RequestDrawing | TimeSpan | ||
| RequestDrawing | IEnumerable<RectangleShape> | ||
| RequestDrawing | IEnumerable<RectangleShape>, TimeSpan | ||
| RequestDrawing | RectangleShape | ||
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| DrawAttributionCore | GeoCanvas | ||
| DrawCore | GeoCanvas | This method draws the Overlay. | |
| DrawException | GeoCanvas, Exception | This method will draw on the canvas when an exception occurs during the drawing process. | |
| DrawExceptionCore | GeoCanvas, Exception | This method is the Core method of DrawException, which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process. | |
| DrawPreviewCore | GeoCanvas | This is the core method of DrawPreview which is intended to be overridden by its concrete sub class. | |
| Finalize | Object | ||
| MemberwiseClone | Object | ||
| OnDrawing | DrawingOverlayEventArgs | This event will be fired before Overlay is drawn. | |
| OnDrawingAttribution | DrawingAttributionOverlayEventArgs | ||
| OnDrawn | DrawnOverlayEventArgs | This event will be fired after Overlay is drawn. | |
| OnDrawnAttribution | DrawnAttributionOverlayEventArgs | ||
| OnRequestedDrawing | RequestedDrawingOverlayEventArgs | ||
| OnRequestingDrawing | RequestingDrawingOverlayEventArgs | ||
| RefreshCore | GeoCanvas, RectangleShape |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Attribution | String | ||
| AutoRefreshInterval | TimeSpan | ||
| DrawingExceptionMode | DrawingExceptionMode | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. | |
| DrawingTime | TimeSpan | This property gets the last drawing time for the Overlay. | |
| IsBase | Boolean | Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false. | |
| IsEmpty | Boolean | This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance. | |
| IsVisible | Boolean | Gets or sets a value that indicates whether the overlay is visible on the map. | |
| Lock | OverlayLock | This property gets the OverlayLock object. | |
| Name | String | Gets or sets the name of the overlay, which can be used to represent a specific overlay. | |
| PreviewTileCache | BitmapTileCache | This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set. | |
| TileCache | BitmapTileCache | This property gets or sets the TileCache used for the overlay. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 Drawing | DrawingOverlayEventArgs | This event will be fired before the Overlay is drawn. | |
| DrawingAttribution | DrawingAttributionOverlayEventArgs | ||
| Drawn | DrawnOverlayEventArgs | This event will be fired after the Overlay is drawn. | |
| DrawnAttribution | DrawnAttributionOverlayEventArgs | ||
| RequestedDrawing | RequestedDrawingOverlayEventArgs | ||
| RequestingDrawing | RequestingDrawingOverlayEventArgs |
Public Constructors
Protected Constructors
Overlay()
Initialize an instance of the Overlay class.
Overloads
Initialize an instance 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.DesktopEdition.Overlay#Overlay.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Overlay.28.29</a>
Parameters
| Name | Type | Description |
|---|
Public Methods
Draw(GeoCanvas)
This method draws the Overlay.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided.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 |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object to draw on. |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawPreview(GeoCanvas)
This method will be used to draw preview tiles to the canvas.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawPreview.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawPreview.28GeoCanvas.29</a>
Return Value
| Return Type | Description |
|---|---|
| TilesExistingType<!– ThinkGeo.MapSuite.DesktopEdition.TilesExistingType –> | The tile existing type, which indicates whether any tiles exist. |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object to draw on. |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#Equals.28Object.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Equals.28Object.29</a>
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> 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.DesktopEdition.Overlay#GetHashCode.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#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.DesktopEdition.Overlay#GetType.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#GetType.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Refresh(GeoCanvas, RectangleShape)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Refresh.28GeoCanvas.2C_RectangleShape.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Refresh.28GeoCanvas.2C_RectangleShape.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| extent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestDrawing()
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 |
|---|
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestDrawing(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.DesktopEdition.Overlay –> Go Back
RequestDrawing(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.DesktopEdition.Overlay –> Go Back
RequestDrawing(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 |
|---|---|---|
| extentToRefresh | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> | |
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestDrawing(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.DesktopEdition.Overlay –> Go Back
RequestDrawing(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 |
|---|---|---|
| bufferTime | TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestDrawing(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.DesktopEdition.Overlay –> Go Back
RequestDrawing(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.DesktopEdition.Overlay –> Go Back
RequestDrawing(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 |
|---|---|---|
| extentToRefresh | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#ToString.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#ToString.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
DrawAttributionCore(GeoCanvas)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawCore(GeoCanvas)
This method draws the Overlay.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided.When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object or a GeoImage to draw on. |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawException(GeoCanvas, Exception)
This method will draw on the canvas when an exception occurs during the drawing process.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawException.28GeoCanvas.2C_Exception.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawException.28GeoCanvas.2C_Exception.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object to draw on. |
| e | Exception<!– System.Exception –> | This parameter is the exception that is occurring. |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawExceptionCore(GeoCanvas, Exception)
This method is the Core method of DrawException, which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object to draw on. |
| e | Exception<!– System.Exception –> | This parameter is the exception that is occurring. |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawPreviewCore(GeoCanvas)
This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawPreviewCore.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawPreviewCore.28GeoCanvas.29</a>
Return Value
| Return Type | Description |
|---|---|
| TilesExistingType<!– ThinkGeo.MapSuite.DesktopEdition.TilesExistingType –> | The tile existing type, which indicates whether any tiles exist. |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter is the canvas object to draw on. |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> 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.DesktopEdition.Overlay#Finalize.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Finalize.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> 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.DesktopEdition.Overlay#MemberwiseClone.28.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#MemberwiseClone.28.29</a>
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnDrawing(DrawingOverlayEventArgs)
This event will be fired before 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.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs –> | The OverlayDrawingEventArgs passed for the event raised. |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
OnDrawn(DrawnOverlayEventArgs)
This event will be fired after 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.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs –> | The OverlayDrawnEventArgs passed for the event raised. |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
OnRequestedDrawing(RequestedDrawingOverlayEventArgs)
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 |
|---|---|---|
| eventArgs | RequestedDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
OnRequestingDrawing(RequestingDrawingOverlayEventArgs)
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 |
|---|---|---|
| eventArgs | RequestingDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RefreshCore(GeoCanvas, RectangleShape)
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29</a>
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| extent | RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> 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.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawAttributionCore.28GeoCanvas.29</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
AutoRefreshInterval
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#DrawingExceptionMode” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawingExceptionMode</a>
Return Value
| Return Type |
|---|
| DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
DrawingTime
This property gets the last drawing time for the Overlay.
Remarks
We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.
Return Value
| Return Type |
|---|
| TimeSpan<!– System.TimeSpan –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
IsBase
Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsBase” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsBase</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
IsEmpty
This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsEmpty” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsEmpty</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
IsVisible
Gets or sets a value that indicates whether the overlay is visible on the map.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsVisible” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#IsVisible</a>
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
Lock
This property gets the OverlayLock object.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Lock” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Lock</a>
Return Value
| Return Type |
|---|
| OverlayLock<!– ThinkGeo.MapSuite.DesktopEdition.OverlayLock –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
Name
Gets or sets the name of the overlay, which can be used to represent a specific overlay.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Name” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Name</a>
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
PreviewTileCache
This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.
Remarks
For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#PreviewTileCache” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#PreviewTileCache</a>
Return Value
| Return Type |
|---|
| BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
TileCache
This property gets or sets the TileCache used for the overlay.
Remarks
The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.
Return Value
| Return Type |
|---|
| BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
Protected Properties
Public Events
Drawing
This event will be fired before 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.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawing.28DrawingOverlayEventArgs.29</a>
Event Arguments
| Event Arguments |
|---|
| DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a>
Event Arguments
| Event Arguments |
|---|
| DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
Drawn
This event will be fired 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.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawn.28DrawnOverlayEventArgs.29</a>
Event Arguments
| Event Arguments |
|---|
| DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.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.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a>
Event Arguments
| Event Arguments |
|---|
| DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestedDrawing
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Event Arguments
| Event Arguments |
|---|
| RequestedDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
RequestingDrawing
Remarks
For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>
Event Arguments
| Event Arguments |
|---|
| RequestingDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs –> |
<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back
NOTOC DesktopEdition ThinkGeo.MapSuite.DesktopEdition UpdateDocumentation
thinkgeo.mapsuite.desktopedition.overlay.1440040130.txt.gz · Last modified: 2015/09/18 03:04 (external edit)