thinkgeo.mapsuite.desktopedition.backgroundoverlay
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.desktopedition.backgroundoverlay [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class inherits from the Overlay abstract class. The specified overlay specifies the background information of the MapControl. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay</a> | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.DesktopEdition.Overlay]] | ||
| - | ***[[ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#BackgroundOverlay()|BackgroundOverlay]] | | | This is the default constructor of the class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas)|Draw]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This method draws the Overlay. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#DrawPreview(GeoCanvas)|DrawPreview]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This method will be used to draw preview tiles to the canvas. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Refresh(GeoCanvas, RectangleShape)|Refresh]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]] | TimeSpan | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]] | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]> | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]] | | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]] | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas)|DrawAttributionCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas)|DrawCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]](overriden) | This method overrides the DrawCore logic in the Overlay base class. Draw all of the background to the image object using the parameters specified. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This method will draw on the canvas when an exception occurs during the drawing process. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawPreviewCore(GeoCanvas)|DrawPreviewCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This is the core method of DrawPreview which is intended to be overridden by its concrete sub class. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawing(DrawingOverlayEventArgs)|OnDrawing]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This event will be fired before Overlay is drawn. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionOverlayEventArgs)|OnDrawingAttribution]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawn(DrawnOverlayEventArgs)|OnDrawn]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This event will be fired after Overlay is drawn. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionOverlayEventArgs)|OnDrawnAttribution]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingOverlayEventArgs)|OnRequestedDrawing]] | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingOverlayEventArgs)|OnRequestingDrawing]] | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RefreshCore(GeoCanvas, RectangleShape)|RefreshCore]] | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]] | String | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#AutoRefreshInterval|AutoRefreshInterval]] | TimeSpan | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BackgroundBrush|BackgroundBrush]] | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]] | | This property gets or sets the background brush for the MapControl. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This property gets the last drawing time for the Overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsBase|IsBase]] | Boolean | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsEmpty|IsEmpty]] | Boolean | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | 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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | Gets or sets a value that indicates whether the overlay is visible on the map. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Lock|Lock]] | [[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This property gets the OverlayLock object. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | Gets or sets the name of the overlay, which can be used to represent a specific overlay. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#PreviewTileCache|PreviewTileCache]] | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|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. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#TileCache|TileCache]] | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|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 ^ | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#Drawing|Drawing]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This event will be fired before the Overlay is drawn. | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#Drawn|Drawn]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | This event will be fired after the Overlay is drawn. | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]] | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]] | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | | {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]] | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]] | [[ThinkGeo.MapSuite.DesktopEdition.Overlay|Overlay]] | | | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== BackgroundOverlay() ==== | ||
| - | This is the default constructor of the class. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundOverlay.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundOverlay.28.29</a> | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|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 | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object to draw on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#DrawPreview.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawPreview.28GeoCanvas.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]<!-- ThinkGeo.MapSuite.DesktopEdition.TilesExistingType --> | The tile existing type, which indicates whether any tiles exist. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object to draw on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Equals.28Object.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#GetHashCode.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#GetType.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#Refresh.28GeoCanvas.2C_RectangleShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Refresh.28GeoCanvas.2C_RectangleShape.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | extent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Public Methods|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<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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 --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | | bufferTime | TimeSpan<!-- System.TimeSpan --> | | | ||
| - | | bufferTimeType | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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 | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#ToString.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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.BackgroundOverlay#DrawAttributionCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawAttributionCore.28GeoCanvas.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== DrawCore(GeoCanvas) ==== | ||
| - | This method overrides the DrawCore logic in the Overlay base class. Draw all of the background to the image object using the parameters specified. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawCore.28GeoCanvas.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter specifies the target canvas on which to draw the current AdormentOverlay. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay(overriden) --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#DrawException.28GeoCanvas.2C_Exception.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawException.28GeoCanvas.2C_Exception.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|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 --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|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 --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#DrawPreviewCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawPreviewCore.28GeoCanvas.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.TilesExistingType|TilesExistingType]]<!-- ThinkGeo.MapSuite.DesktopEdition.TilesExistingType --> | The tile existing type, which indicates whether any tiles exist. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | This parameter is the canvas object to draw on. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Finalize.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#MemberwiseClone.28.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs --> | The OverlayDrawingEventArgs passed for the event raised. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#OnDrawn.28DrawnOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawn.28DrawnOverlayEventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | e | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs --> | The OverlayDrawnEventArgs passed for the event raised. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | args | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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 | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | canvas | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> | | | ||
| - | | extent | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape --> | | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Protected Methods|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.BackgroundOverlay#DrawAttributionCore.28GeoCanvas.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawAttributionCore.28GeoCanvas.29</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== BackgroundBrush ==== | ||
| - | This property gets or sets the background brush for the MapControl. | ||
| - | === Remarks === | ||
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundBrush" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#BackgroundBrush</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.Core.GeoBrush --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#DrawingExceptionMode" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#DrawingExceptionMode</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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 --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#IsBase" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsBase</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#IsEmpty" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsEmpty</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#IsVisible" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#IsVisible</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#Lock" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Lock</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.OverlayLock|OverlayLock]]<!-- ThinkGeo.MapSuite.DesktopEdition.OverlayLock --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#Name" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#Name</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#PreviewTileCache" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#PreviewTileCache</a> | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BitmapTileCache|BitmapTileCache]]<!-- ThinkGeo.MapSuite.Core.BitmapTileCache --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Properties|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.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawing.28DrawingOverlayEventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs|DrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|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.BackgroundOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs|DrawingAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|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.BackgroundOverlay#OnDrawn.28DrawnOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawn.28DrawnOverlayEventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs|DrawnOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|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.BackgroundOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29</a> | ||
| - | === Event Arguments === | ||
| - | ^ Event Arguments ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs|DrawnAttributionOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs|RequestedDrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs|RequestingDrawingOverlayEventArgs]]<!-- ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.DesktopEdition.Overlay --> | ||
| - | [[#Public Events|Go Back]] | ||
| - | |||
| - | __NOTOC__ | ||
| - | [[Category:DesktopEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.DesktopEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.desktopedition.backgroundoverlay.1440040130.txt.gz ยท Last modified: 2015/09/18 03:01 (external edit)
