====== ThinkGeo.UI.Wpf.BackgroundOverlay ======
===== Inheritance Hierarchy =====
*System.Object
*ThinkGeo.UI.Wpf.Overlay
***ThinkGeo.UI.Wpf.BackgroundOverlay**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} BackgroundOverlay() **
* //Constructor of BackgroundOverlay class.//
== Remarks ==
* //N/A//
== Parameters ==
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} Initialize(MapArguments) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.UI.Wpf.MapArguments|MapArguments]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Close() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Open() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //targetExtent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Draw(RectangleShape,OverlayRefreshType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //targetExtent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //refreshType//
* Type:[[ThinkGeo.UI.Wpf.OverlayRefreshType|OverlayRefreshType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} PanTo(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //targetExtent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} SaveState() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Byte[]
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} LoadState(Byte[]) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //state//
* Type:Byte[]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Dispose() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]>
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentToRefresh//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentToRefresh//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable,TimeSpan) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]>
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
** {{wiki:PublicMethod.gif|}} Refresh(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extentsToRefresh//
* Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]>
* Description:N/A
* //bufferTime//
* Type:TimeSpan
* Description:N/A
* //bufferTimeType//
* Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetType() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Type
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:String
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
* Description:N/A
== Parameters ==
* //obj//
* Type:Object
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Int32
* Description:N/A
== Parameters ==
===== Protected Methods =====
** {{wiki:ProtectedMethod.gif|}} DrawCore(RectangleShape,OverlayRefreshType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //targetExtent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:This parameter specifies the extent for drawing this overlay.
* //refreshType//
* Type:[[ThinkGeo.UI.Wpf.OverlayRefreshType|OverlayRefreshType]]
* Description:This parameter specifies whether this overlay need to be clear and refresh or not.
** {{wiki:ProtectedMethod.gif|}} SaveStateCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Byte[]
* Description:A byte array indicates current overlay state.
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} LoadStateCore(Byte[]) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //state//
* Type:Byte[]
* Description:This parameter indicates the state for restore the overlay.
** {{wiki:ProtectedMethod.gif|}} InitializeCore(MapArguments) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //mapArguments//
* Type:[[ThinkGeo.UI.Wpf.MapArguments|MapArguments]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} RefreshCore(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //extent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} RefreshCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawAttribution(GeoCanvas) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //canvas//
* Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.UI.Wpf.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //args//
* Type:[[ThinkGeo.UI.Wpf.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} PanToCore(RectangleShape) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //targetExtent//
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawing(DrawingOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.UI.Wpf.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawn(DrawnOverlayEventArgs) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //e//
* Type:[[ThinkGeo.UI.Wpf.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} Dispose(Boolean) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //disposing//
* Type:Boolean
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRefreshing(OverlayRefreshType) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //refreshType//
* Type:[[ThinkGeo.UI.Wpf.OverlayRefreshType|OverlayRefreshType]]
* Description:N/A
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Object
* Description:N/A
== Parameters ==
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} BackgroundBrush **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.Core.GeoBrush|GeoBrush]]
** {{wiki:PublicProperty.gif|}} Name **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} MapArguments **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.UI.Wpf.MapArguments|MapArguments]]
** {{wiki:PublicProperty.gif|}} OverlayCanvas **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Canvas
** {{wiki:PublicProperty.gif|}} IsBase **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} CanRefreshRegion **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.Core.DrawingExceptionMode|DrawingExceptionMode]]
** {{wiki:PublicProperty.gif|}} IsVisible **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} Attribution **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:String
** {{wiki:PublicProperty.gif|}} IsEmpty **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
** {{wiki:PublicProperty.gif|}} AutoRefreshInterval **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:TimeSpan
==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} PreviousExtent **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]]
** {{wiki:ProtectedProperty.gif|}} PreviousScale **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Double
** {{wiki:ProtectedProperty.gif|}} IsOverlayInitialized **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
==== Public Events ====
** {{wiki:PublicEvent.gif|}} Drawing **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.UI.Wpf.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} Drawn **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.UI.Wpf.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} DrawingAttribution **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.UI.Wpf.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]
** {{wiki:PublicEvent.gif|}} DrawnAttribution **
* //N/A//
== Remarks ==
* //N/A//
Event Arguments:[[ThinkGeo.UI.Wpf.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]