User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.printerinteractiveoverlay

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay

<!– Class –>

Remarks

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodPrinterInteractiveOverLay

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodDraw GeoCanvas Overlay This method draws the Overlay.
Public MethodDrawPreview GeoCanvas Overlay This method will be used to draw preview tiles to the canvas.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodKeyDown KeyEventInteractionArguments InteractiveOverlay This method will simulate the KeyDown interaction.
Public MethodKeyUp KeyEventInteractionArguments InteractiveOverlay This method will simulate the KeyUp interaction.
Public MethodMouseClick InteractionArguments InteractiveOverlay This method will simulate the MouseClick interaction.
Public MethodMouseDoubleClick InteractionArguments InteractiveOverlay This method will simulate the MouseDoubleClick interaction.
Public MethodMouseDown InteractionArguments InteractiveOverlay This method will simulate the MouseDown interaction.
Public MethodMouseMove InteractionArguments InteractiveOverlay This method will simulate the MouseMove interaction.
Public MethodMouseUp InteractionArguments InteractiveOverlay This method will simulate the MouseUp interaction.
Public MethodMouseWheel InteractionArguments InteractiveOverlay This method will simulate the MouseWheel interaction.
Public MethodRefresh GeoCanvas, RectangleShape Overlay
Public MethodRequestDrawing RectangleShape, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan Overlay
Public MethodRequestDrawing IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRequestDrawing TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRequestDrawing TimeSpan Overlay
Public MethodRequestDrawing IEnumerable<RectangleShape> Overlay
Public MethodRequestDrawing RectangleShape Overlay
Public MethodRequestDrawing Overlay
Public MethodRequestDrawing RectangleShape, TimeSpan Overlay
Public MethodToString Object
Public MethodStatic Memberget_InteractiveClickInterval InteractiveOverlay
Public MethodStatic Memberset_InteractiveClickInterval Int32 InteractiveOverlay

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodDrawAttributionCore GeoCanvas Overlay
Protected MethodDrawCore GeoCanvas Overlay(overriden)
Protected MethodDrawException GeoCanvas, Exception Overlay This method will draw on the canvas when an exception occurs during the drawing process.
Protected MethodDrawExceptionCore GeoCanvas, Exception Overlay 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.
Protected MethodDrawPreviewCore GeoCanvas Overlay This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
Protected MethodFinalize Object
Protected MethodKeyDownCore KeyEventInteractionArguments InteractiveOverlay This protected virtual method is the Core method of KeyDown API.
Protected MethodKeyUpCore KeyEventInteractionArguments InteractiveOverlay This protected virtual method is the Core method of KeyDown API.
Protected MethodMemberwiseClone Object
Protected MethodMouseClickCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodMouseDoubleClickCore InteractionArguments InteractiveOverlay This protected virtual method is the Core method of the MouseDoubleClick API.
Protected MethodMouseDownCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodMouseMoveCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodMouseUpCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodMouseWheelCore InteractionArguments InteractiveOverlay This protected virtual method is the Core method of the MouseWheel API.
Protected MethodOnDrawing DrawingOverlayEventArgs Overlay This event will be fired before Overlay is drawn.
Protected MethodOnDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Protected MethodOnDrawn DrawnOverlayEventArgs Overlay This event will be fired after Overlay is drawn.
Protected MethodOnDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Protected MethodOnMapKeyDown MapKeyDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapKeyDown is called.
Protected MethodOnMapKeyUp MapKeyUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapKeyUp is called.
Protected MethodOnMapMouseClick MapMouseClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseClick is called.
Protected MethodOnMapMouseDoubleClick MapMouseDoubleClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseDoubleClick is called.
Protected MethodOnMapMouseDown MapMouseDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseDown is called.
Protected MethodOnMapMouseMove MapMouseMoveInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseMove is called.
Protected MethodOnMapMouseUp MapMouseUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseUp is called.
Protected MethodOnMapMouseWheel MapMouseWheelInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseWheel is called.
Protected MethodOnRequestedDrawing RequestedDrawingOverlayEventArgs Overlay
Protected MethodOnRequestingDrawing RequestingDrawingOverlayEventArgs Overlay
Protected MethodRefreshCore GeoCanvas, RectangleShape Overlay

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay
Public PropertyControlPointStyle PointStyle
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingTime TimeSpan Overlay This property gets the last drawing time for the Overlay.
Public PropertyEditMask AreaStyle
Public PropertyIsBase Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.
Public PropertyIsEditable Boolean
Public PropertyIsEmpty Boolean Overlay(overriden)
Public PropertyIsVisible Boolean Overlay Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyLock OverlayLock Overlay This property gets the OverlayLock object.
Public PropertyName String Overlay Gets or sets the name of the overlay, which can be used to represent a specific overlay.
Public PropertyPreviewTileCache BitmapTileCache Overlay 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.
Public PropertyPrinterLayers GeoCollection<PrinterLayer>
Public PropertyTileCache BitmapTileCache Overlay This property gets or sets the TileCache used for the overlay.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary
Public EventDrawing DrawingOverlayEventArgs Overlay This event will be fired before the Overlay is drawn.
Public EventDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Public EventDrawn DrawnOverlayEventArgs Overlay This event will be fired after the Overlay is drawn.
Public EventDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Public EventMapKeyDown MapKeyDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the key is pressed down when focusing on the Map.
Public EventMapKeyUp MapKeyUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the key is released up when focusing on the Map.
Public EventMapMouseClick MapMouseClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse button is clicked (mouse up and mouse down in the same postion) on the Map.
Public EventMapMouseDoubleClick MapMouseDoubleClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse button is double-clicked on the Map.
Public EventMapMouseDown MapMouseDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse button is pressed (down) on the Map.
Public EventMapMouseMove MapMouseMoveInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse is moved on the Map.
Public EventMapMouseUp MapMouseUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse button is released (up) on the Map.
Public EventMapMouseWheel MapMouseWheelInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when the Mouse wheel is scrolled while the cursor is over the Map.
Public EventRequestedDrawing RequestedDrawingOverlayEventArgs Overlay
Public EventRequestingDrawing RequestingDrawingOverlayEventArgs Overlay

Public Constructors

PrinterInteractiveOverLay()

Remarks

Parameters

Name Type Description

Go Back

Protected Constructors

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

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

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

KeyDown(KeyEventInteractionArguments)

This method will simulate the KeyDown interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.KeyEventInteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

KeyUp(KeyEventInteractionArguments)

This method will simulate the KeyUp interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.KeyEventInteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseClick(InteractionArguments)

This method will simulate the MouseClick interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseDoubleClick(InteractionArguments)

This method will simulate the MouseDoubleClick interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseDown(InteractionArguments)

This method will simulate the MouseDown interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseMove(InteractionArguments)

This method will simulate the MouseMove interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseUp(InteractionArguments)

This method will simulate the MouseUp interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseWheel(InteractionArguments)

This method will simulate the MouseWheel interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

Refresh(GeoCanvas, RectangleShape)

Remarks

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(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(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(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(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(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

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(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

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

get_InteractiveClickInterval()

<!– static –>

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

set_InteractiveClickInterval(Int32)

<!– static –>

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
value Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

Protected Methods

DrawAttributionCore(GeoCanvas)

Remarks

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)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay(overriden) –> Go Back

DrawException(GeoCanvas, Exception)

This method will draw on the canvas when an exception occurs during the drawing process.

Remarks

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

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

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

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

KeyDownCore(KeyEventInteractionArguments)

This protected virtual method is the Core method of KeyDown API.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.KeyEventInteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

KeyUpCore(KeyEventInteractionArguments)

This protected virtual method is the Core method of KeyDown API.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.KeyEventInteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

MouseClickCore(InteractionArguments)

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseDoubleClickCore(InteractionArguments)

This protected virtual method is the Core method of the MouseDoubleClick API.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MouseDownCore(InteractionArguments)

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseMoveCore(InteractionArguments)

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseUpCore(InteractionArguments)

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseWheelCore(InteractionArguments)

This protected virtual method is the Core method of the MouseWheel API.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.DesktopEdition.InteractionArguments –> This parameter represents the interaction auguments for the method.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnDrawing(DrawingOverlayEventArgs)

This event will be fired before Overlay is drawn.

Remarks

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

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

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

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnMapKeyDown(MapKeyDownInteractiveOverlayEventArgs)

This event will be fired when MapKeyDown is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapKeyDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapKeyDownInteractiveOverlayEventArgs –> The MapKeyDownInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapKeyUp(MapKeyUpInteractiveOverlayEventArgs)

This event will be fired when MapKeyUp is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapKeyUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapKeyUpInteractiveOverlayEventArgs –> The MapKeyUpInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseClick(MapMouseClickInteractiveOverlayEventArgs)

This event will be fired when MapMouseClick is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseClickInteractiveOverlayEventArgs –> The MapMouseClickInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseDoubleClick(MapMouseDoubleClickInteractiveOverlayEventArgs)

This event will be fired when MapMouseDoubleClick is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseDoubleClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseDoubleClickInteractiveOverlayEventArgs –> The MapMouseDoubleClickInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseDown(MapMouseDownInteractiveOverlayEventArgs)

This event will be fired when MapMouseDown is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseDownInteractiveOverlayEventArgs –> The MapMouseDownInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseMove(MapMouseMoveInteractiveOverlayEventArgs)

This event will be fired when MapMouseMove is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseMoveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseMoveInteractiveOverlayEventArgs –> The MapMouseMoveInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseUp(MapMouseUpInteractiveOverlayEventArgs)

This event will be fired when MapMouseUp is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseUpInteractiveOverlayEventArgs –> The MapMouseUpInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseWheel(MapMouseWheelInteractiveOverlayEventArgs)

This event will be fired when MapMouseWheel is called.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e MapMouseWheelInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseWheelInteractiveOverlayEventArgs –> The MapMouseWheelInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> 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

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

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

ControlPointStyle

Remarks

Return Value

Return Type
PointStyle<!– ThinkGeo.MapSuite.Core.PointStyle –>

<!– ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay –> Go Back

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

Remarks

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

EditMask

Remarks

Return Value

Return Type
AreaStyle<!– ThinkGeo.MapSuite.Core.AreaStyle –>

<!– ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay –> Go Back

IsBase

Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

IsEditable

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay –> Go Back

IsEmpty

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay(overriden) –> Go Back

IsVisible

Gets or sets a value that indicates whether the overlay is visible on the map.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Lock

This property gets the OverlayLock object.

Remarks

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

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

Return Value

Return Type
BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

PrinterLayers

Remarks

Return Value

Return Type
GeoCollection<PrinterLayer><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.PrinterLayer} –>

<!– ThinkGeo.MapSuite.DesktopEdition.PrinterInteractiveOverLay –> 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

Event Arguments

Event Arguments
DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawingAttribution

Remarks

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

Event Arguments

Event Arguments
DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawnAttribution

Remarks

Event Arguments

Event Arguments
DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

MapKeyDown

This event will be fired when the key is pressed down when focusing on the Map.

Remarks

Event Arguments

Event Arguments
MapKeyDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapKeyDownInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapKeyUp

This event will be fired when the key is released up when focusing on the Map.

Remarks

Event Arguments

Event Arguments
MapKeyUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapKeyUpInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseClick

This event will be fired when the Mouse button is clicked (mouse up and mouse down in the same postion) on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseClickInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseDoubleClick

This event will be fired when the Mouse button is double-clicked on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseDoubleClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseDoubleClickInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseDown

This event will be fired when the Mouse button is pressed (down) on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseDownInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseMove

This event will be fired when the Mouse is moved on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseMoveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseMoveInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseUp

This event will be fired when the Mouse button is released (up) on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseUpInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> Go Back

MapMouseWheel

This event will be fired when the Mouse wheel is scrolled while the cursor is over the Map.

Remarks

Event Arguments

Event Arguments
MapMouseWheelInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.MapMouseWheelInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay –> 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.printerinteractiveoverlay.1440040130.txt.gz · Last modified: 2015/09/18 03:04 (external edit)