AdornmentOverlay¶
Inheritance Hierarchy¶
ObjectOverlayAdornmentOverlay
Members Summary¶
Public Constructors Summary¶
| Name |
|---|
AdornmentOverlay() |
Protected Constructors Summary¶
| Name |
|---|
| N/A |
Public Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
Attribution | String | N/A |
AutoRefreshInterval | TimeSpan | N/A |
CanRefreshRegion | Boolean | N/A |
DrawingExceptionMode | DrawingExceptionMode | N/A |
IsBase | Boolean | N/A |
IsEmpty | Boolean | This property indicates whether this overlay is empty or not. |
IsVisible | Boolean | N/A |
Layers | GeoCollection<AdornmentLayer> | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. |
MapArguments | MapArguments | N/A |
Name | String | N/A |
OverlayCanvas | Canvas | N/A |
Protected Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
IsOverlayInitialized | Boolean | N/A |
PreviousExtent | RectangleShape | N/A |
PreviousScale | Double | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
| Name | Event Arguments | Description |
|---|---|---|
Drawing | DrawingOverlayEventArgs | N/A |
Drawn | DrawnOverlayEventArgs | N/A |
DrawingAttribution | DrawingAttributionOverlayEventArgs | N/A |
DrawnAttribution | DrawnAttributionOverlayEventArgs | N/A |
Members Detail¶
Public Constructors¶
| Name |
|---|
AdornmentOverlay() |
Protected Constructors¶
Public Properties¶
Attribution¶
Summary
N/A
Remarks
N/A
Return Value
String
AutoRefreshInterval¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
CanRefreshRegion¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
DrawingExceptionMode¶
Summary
N/A
Remarks
N/A
Return Value
IsBase¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsEmpty¶
Summary
This property indicates whether this overlay is empty or not.
Remarks
N/A
Return Value
Boolean
IsVisible¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Layers¶
Summary
This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
Remarks
N/A
Return Value
GeoCollection<AdornmentLayer>
MapArguments¶
Summary
N/A
Remarks
N/A
Return Value
Name¶
Summary
N/A
Remarks
N/A
Return Value
String
OverlayCanvas¶
Summary
N/A
Remarks
N/A
Return Value
Canvas
Protected Properties¶
IsOverlayInitialized¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
PreviousExtent¶
Summary
N/A
Remarks
N/A
Return Value
PreviousScale¶
Summary
N/A
Remarks
N/A
Return Value
Double
Public Methods¶
Close()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Dispose()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Draw(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetExtent | RectangleShape | N/A |
Draw(RectangleShape,OverlayRefreshType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetExtent | RectangleShape | N/A |
| refreshType | OverlayRefreshType | N/A |
Equals(Object)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | N/A |
GetBoundingBox()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetHashCode()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Int32 | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Type | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Initialize(MapArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | N/A |
LoadState(Byte[])¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| state | Byte[] | N/A |
Open()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
PanTo(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetExtent | RectangleShape | N/A |
Refresh(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extent | RectangleShape | N/A |
Refresh()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Refresh(IEnumerable<RectangleShape>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
Refresh(TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
Refresh(TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
Refresh(RectangleShape,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
Refresh(IEnumerable<RectangleShape>,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
SaveState()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
ToString()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Protected Methods¶
CloseCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Dispose(Boolean)¶
Summary
This method disposes the unmanaged resource used in this overlay.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| disposing | Boolean | N/A |
DrawAttribution(GeoCanvas)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
DrawAttributionCore(GeoCanvas)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
DrawCore(RectangleShape,OverlayRefreshType)¶
Summary
This method override the DrawCore logic of the Overlay class.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetExtent | RectangleShape | This parameter specifies the extent for drawing this overlay. |
| overlayRefreshType | OverlayRefreshType | This parameter specifies whether this overlay need to be clear and refresh or not. |
Finalize()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetBoundingBoxCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
InitializeCore(MapArguments)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| mapArguments | MapArguments | N/A |
LoadStateCore(Byte[])¶
Summary
This method restore the overlay state back from the specified state.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| state | Byte[] | This parameter indicates the state for restore the overlay. |
MemberwiseClone()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Object | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
OnDrawing(DrawingOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingOverlayEventArgs | N/A |
OnDrawingAttribution(DrawingAttributionOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingAttributionOverlayEventArgs | N/A |
OnDrawn(DrawnOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawnOverlayEventArgs | N/A |
OnDrawnAttribution(DrawnAttributionOverlayEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnAttributionOverlayEventArgs | N/A |
OnRefreshing(OverlayRefreshType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| refreshType | OverlayRefreshType | N/A |
OpenCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
PanToCore(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| targetExtent | RectangleShape | N/A |
RefreshCore(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extent | RectangleShape | N/A |
RefreshCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
SaveStateCore()¶
Summary
This method saves overlay state to a byte array.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Byte[] | A byte array indicates current overlay state. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Public Events¶
Drawing¶
N/A
Remarks
N/A
Event Arguments
Drawn¶
N/A
Remarks
N/A
Event Arguments
DrawingAttribution¶
N/A
Remarks
N/A
Event Arguments
DrawingAttributionOverlayEventArgs
DrawnAttribution¶
N/A
Remarks
N/A
Event Arguments