====== ThinkGeo.MapSuite.WebEdition.AdornmentOverlay ====== {{section>upgrade_map_suite_to_10.0}} This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl. ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.WebEdition.Overlay ***ThinkGeo.MapSuite.WebEdition.AdornmentOverlay** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} AdornmentOverlay() ** * //Initialize an instance of the AdornmentOverlay class.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28.29// == Parameters ==
** {{wiki:PublicMethod.gif|}} AdornmentOverlay(String) ** * //Initialize an instance of the AdornmentOverlay class with the overlay identifier specified.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AdornmentOverlay.28String.29// == Parameters == * //id// * Type:String * Description:The identifier string used to retrieve the overlay for collection.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas) ** * //Draw all of the layers to the image object using the parameters specified.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:This parameter specifies the target canvas to draw the current AdornmentOverlay on.
** {{wiki:PublicMethod.gif|}} ToJson() ** * //Returns a JSON string which contains the information for creating an overlay at the client side.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToJson.28.29// == Return Value == * Type:String * Description:A JSON string which is used to create an overlay at the client side. == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToString.28.29// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Equals.28Object.29// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetHashCode.28.29// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#GetType.28.29// == Return Value == * Type:Type * Description:N/A == Parameters ==
==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas) ** * //This method overrides the DrawCore logic in the Overlay base class. Draw all of the AdornmentLayers to the image object using the parameters specified.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#DrawCore.28GeoCanvas.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] * Description:This parameter specifies the target canvas to draw the current AdornmentOverlay on.
** {{wiki:ProtectedMethod.gif|}} 3xM=(Page) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //page// * Type:Page * Description:N/A
** {{wiki:ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) ** * //Registers a Javascript library URL string to the client HTML page.// == Remarks == * //The RegisterJavaScriptLibraryCore method allows derived classes to override and register their own Javascript library URL to the HTML page.// == Return Value == * Type:Void * Description:N/A == Parameters == * //page// * Type:Page * Description:The page object that is used for registering the javascript library.
** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:EventArgs * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnTick(EventArgs) ** * //Raises the Tick event of the MarkerOverlay.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:EventArgs * Description:An System.EventArgs object that contains the event data.
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Finalize.28.29// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#MemberwiseClone.28.29// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} Layers ** This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Layers == Return Value == * Type:[[ThinkGeo.MapSuite.Core.GeoCollection[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore, Version=9.0.0.0, Culture=neutral, PublicKeyToken=null]]|GeoCollection]] ** {{wiki:PublicProperty.gif|}} 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:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisible == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Name ** Gets or sets the name of the overlay, which will display in the OverlaySwitcher. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Name == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Opacity ** Gets or sets the opacity level of the overlay. == Remarks == The Opacity property enables you to specify a level of transparency for the overlay. When this property is set to a value less than 100 percent (1.00), the entire overlay is made more transparent. The lower the value, the more transparent it is. Setting this property to a value of 0 percent (0.00) makes the overlay completely invisible. == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisibleInOverlaySwitcher == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsBaseOverlay ** Gets or sets a value that indicates whether the overlay is a base overlay. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsBaseOverlay == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Id ** Gets the identifier for the overlay to be found. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Id == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} AutoRefreshInterval ** Gets or sets the time interval in which the MarkerOverlay refreshes itself. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#AutoRefreshInterval == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Attribution ** N/A == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Attribution == Return Value == * Type:String ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} 4RM= ** N/A == Remarks == N/A == Return Value == * Type:[[ThinkGeo.MapSuite.WebEdition.TileType|TileType]] ** {{wiki:ProtectedProperty.gif|}} OverlayType ** Gets a string that indicates the overlay type. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OverlayType == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} HasTickEvent ** Indicates whether the overlay supports tick event. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#HasTickEvent == Return Value == * Type:Boolean ** {{wiki:ProtectedProperty.gif|}} 3hM= ** N/A == Remarks == N/A == Return Value == * Type:Double ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} Tick ** Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#OnTick.28EventArgs.29 Event Arguments:EventArgs