User Tools

Site Tools

Trace:
thinkgeo.mapsuite.webedition.adornmentoverlay

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.webedition.adornmentoverlay [2015/08/20 03:08]
127.0.0.1 external edit 		thinkgeo.mapsuite.webedition.adornmentoverlay [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.WebEdition.AdornmentOverlay ====== ====== ThinkGeo.MapSuite.WebEdition.AdornmentOverlay ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl. This class inherits from the Overlay abstract class. This specified overlay stores the AdornmentLayer used in the MapControl.
-=== Remarks === 
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay</​a>​ 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.WebEdition.Overlay]] +    *ThinkGeo.MapSuite.WebEdition.Overlay 
-***[[ThinkGeo.MapSuite.WebEdition.AdornmentOverlay]]+      ***ThinkGeo.MapSuite.WebEdition.AdornmentOverlay**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} AdornmentOverlay() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#AdornmentOverlay()|AdornmentOverlay]] ​  ​| ​   |    | Initialize an instance of the AdornmentOverlay class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​AdornmentOverlay(String)|AdornmentOverlay]] ​  | String ​  ​| ​   | Initialize an instance of the AdornmentOverlay class with the overlay identifier specified. ​  |+
  
-==== Protected Constructors ​==== +  * //​Initialize an instance of the AdornmentOverlay class.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== 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 ​== 
 +<div newline></​div>​ 
 +** {{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.
 +
 +<div newline></​div>​
 +==== Protected Constructors ====
 ==== Public Methods ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} Draw(GeoCanvas) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas)|Draw]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​| ​   | Draw all of the layers to the image object using the parameters specified. ​  | +
-| {{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}}[[#​ToJson()|ToJson]] ​  ​| ​   | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Returns a JSON string which contains the information for creating an overlay at the client side.   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +  ​* //Draw all of the layers ​to the image object using the parameters specified.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks == 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​DrawCore(GeoCanvas)|DrawCore]] ​  ​| [[ThinkGeo.MapSuite.Core.GeoCanvas|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. ​  | +  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/​wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#Draw.28GeoCanvas.29//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnTick(EventArgs)|OnTick]] ​  | EventArgs ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Raises the Tick event of the MarkerOverlay. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#RegisterJavaScriptLibraryCore(Page)|RegisterJavaScriptLibraryCore]] ​  | Page   | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Registers a Javascript library URL string to the client HTML page.   |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:Void 
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Attribution|Attribution]] ​  | String ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  ​| ​   | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​AutoRefreshInterval|AutoRefreshInterval]] ​  | TimeSpan ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets the time interval in which the MarkerOverlay refreshes itself. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Id|Id]] ​  | String ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets the identifier for the overlay to be found. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsBaseOverlay|IsBaseOverlay]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is a base overlay. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisible|IsVisible]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay is visible on the map.   | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​IsVisibleInOverlaySwitcher|IsVisibleInOverlaySwitcher]] ​  | Boolean ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Layers|Layers]] ​  | [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<​[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]> ​  ​| ​   | This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Name|Name]] ​  | String ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets the name of the overlay, which will display in the OverlaySwitcher. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​Opacity|Opacity]] ​  | Single ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Gets or sets the opacity level of the overlay. ​  |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * //canvas// 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​HasTickEvent|HasTickEvent]] ​  | Boolean ​  ​| ​[[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]]   | Indicates whether the overlay supports tick event. ​  | +    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#​OverlayType|OverlayType]] ​  | String ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]](overriden) ​  | Gets a string that indicates ​the overlay type.   |+    * Description:This parameter specifies ​the target canvas to draw the current AdornmentOverlay on.
  
-==== Public Events ==== +<div newline></​div>​ 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ +** {{wiki:PublicMethod.gif|}} ​ToJson() **
-| {{wiki:PublicEvent.gif|Public Event}}[[#​Tick|Tick]] ​  | EventArgs ​  | [[ThinkGeo.MapSuite.WebEdition.Overlay|Overlay]] ​  | Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server. ​  |+
  
-===== Public Constructors ===== +  * //Returns a JSON string which contains ​the information for creating ​an overlay at the client side.// 
-==== AdornmentOverlay() ==== +== Remarks == 
-Initialize an instance of the AdornmentOverlay class. +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​ToJson.28.29//
-=== Overloads === +
-Initialize ​an instance of the AdornmentOverlay class. +
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AdornmentOverlay.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AdornmentOverlay.28.29</​a>​ +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-==== AdornmentOverlay(String) ​==== +  * Type:String 
-Initialize an instance of the AdornmentOverlay class with the overlay identifier specified. +  ​* Description:A JSON string ​which is used to create an overlay ​at the client side.
-=== Overloads === +
-Initialize an instance of the AdornmentOverlay class. +
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AdornmentOverlay.28String.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AdornmentOverlay.28String.29</​a>​ +
-=== Parameters === +
-^  Name ^  Type ^  ​Description ​^ +
-| id   | String<​!-- System.String --> ​  | The identifier ​string used to retrieve the overlay ​for collection.   |+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-===== Protected Constructors ===== +<div newline></div> 
-===== Public Methods ===== +** {{wiki:​PublicMethod.gif|}} ToString() **
-==== 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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Draw.28GeoCanvas.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Draw.28GeoCanvas.29</a> +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ​ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter specifies the target canvas to draw the current ​AdornmentOverlay ​on.   |+  ​* //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#ToString.28.29//
  
-<!-- ThinkGeo.MapSuite.WebEdition.AdornmentOverlay --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:String 
-==== Equals(Object) ==== +  * Description:N/A
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Equals.28Object.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Equals.28Object.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  Type ^  Description ^ +<div newline></​div>​ 
-| obj   ​| ​Object<!-- System.Object --> ​  ​| ​   |+** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-==== GetHashCode() ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Equals.28Object.29//
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​GetHashCode.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​GetHashCode.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Boolean 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +  ​* ​//obj// 
-==== GetType() ​==== +    ​* ​Type:Object 
-=== Remarks === +    ​* Description:​N/​A
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​GetType.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​GetType.28.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+** {{wiki:​PublicMethod.gif|}} GetHashCode() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks == 
-==== ToJson() ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​GetHashCode.28.29//
-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:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​ToJson.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​ToJson.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  | A JSON string which is used to create an overlay at the client side.   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Int32 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></div> 
-==== ToString() ​==== +** {{wiki:​PublicMethod.gif|}} GetType() **
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​ToString.28.29"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​ToString.28.29</a> +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| String<​!-- System.String --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== 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//​
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Type 
-===== Protected Methods ===== +  * Description:N/A
-==== 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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​DrawCore.28GeoCanvas.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​DrawCore.28GeoCanvas.29</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters ​== 
-^  Name ^  Type ^  Description ^ +<div newline></​div>​ 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  | This parameter specifies the target canvas to draw the current AdornmentOverlay on.   |+==== Protected Methods ==== 
 +** {{wiki:​ProtectedMethod.gif|}} DrawCore(GeoCanvas) **
  
-<!-- ThinkGeo.MapSuite.WebEdition.AdornmentOverlay --> +  * //This method overrides the DrawCore logic in the Overlay base class. Draw all of the AdornmentLayers to the image object using the parameters specified.// 
-[[#​Protected Methods|Go Back]] +== Remarks == 
-==== Finalize() ==== +  * //For the most updated Info for this topic, please check it here:​http:​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​DrawCore.28GeoCanvas.29//
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Finalize.28.29" target="​_blank">​http:​//wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Finalize.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +  ​* ​//canvas// 
-==== MemberwiseClone() ​==== +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-=== Remarks === +    ​* ​Description:This parameter specifies the target canvas to draw the current AdornmentOverlay on.
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​MemberwiseClone.28.29"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​MemberwiseClone.28.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^+** {{wiki:​ProtectedMethod.gif|}} 3xM=(Page) **
  
-<!-- System.Object --> +  * //N/A// 
-[[#​Protected Methods|Go Back]] +== Remarks == 
-==== OnTick(EventArgs) ==== +  ​* ​//N/A//
-Raises the Tick event of the MarkerOverlay. +
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OnTick.28EventArgs.29"​ target="​_blank">​http:​//​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OnTick.28EventArgs.29</​a>​ +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^ +  ​* Type:Void 
-| e   | EventArgs<​!-- System.EventArgs --> ​  | An System.EventArgs object that contains the event data.   |+  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +  * //page// 
-==== RegisterJavaScriptLibraryCore(Page) ​==== +    ​* ​Type:Page 
-Registers a Javascript library URL string to the client HTML page. +    ​* Description:​N/​A
-=== Remarks === +
-The &​lt;​strong&​gt;​RegisterJavaScriptLibraryCore&​lt;​/strong&​gt;​ method allows derived classes to override and register their own Javascript library URL to the HTML page. +
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​ProtectedMethod.gif|}} RegisterJavaScriptLibraryCore(Page) **
-| page   | Page<!-- System.Web.UI.Page -->   | The page object that is used for registering the javascript library.   ​|+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +  * //Registers a Javascript library URL string to the client HTML page.// 
-[[#​Protected Methods|Go Back]] +== Remarks == 
-===== Public Properties ===== +  ​* ​//The <​strong>​RegisterJavaScriptLibraryCore<​/strong> method allows derived classes to override and register their own Javascript library URL to the HTML page.//
-==== Attribution ==== +
-=== Remarks ​=== +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Attribution"​ target="​_blank"​>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Attribution</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +== Return Value == 
-[[#Public Properties|Go Back]] +  ​* ​Type:Void 
-==== AutoRefreshInterval ==== +  * Description:​N/​A
-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:<a href="​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AutoRefreshInterval"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​AutoRefreshInterval</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ +
-| TimeSpan<​!-- System.TimeSpan --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +== Parameters ​== 
-[[#Public Properties|Go Back]] +  ​* ​//page// 
-==== Id ==== +    ​* ​Type:Page 
-Gets the identifier for the overlay to be found. +    * Description:​The page object that is used for registering the javascript library.
-=== Remarks === +
-For the most updated Info for this topic, please check it here:<a href="​http:​//wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Id"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Id</​a>​ +
-=== Return Value === +
-^ Return ​Type ^ +
-| String<​!-- System.String --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +<div newline></div> 
-[[#Public Properties|Go Back]] +** {{wiki:ProtectedMethod.gif|}} RaiseTickEvent(EventArgs) **
-==== 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:<a href="​http:/​/wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​IsBaseOverlay"​ target="​_blank">​http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​IsBaseOverlay</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +  * //N/A// 
-[[#Public Properties|Go Back]] +== Remarks == 
-==== IsVisible ==== +  ​* ​//N/A//
-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.WebEdition.AdornmentOverlay#​IsVisible"​ target="​_blank">​http:​//​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​IsVisible</​a>​ +
-=== Return Value === +
-^ Return Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +== Return Value == 
-[[#Public Properties|Go Back]] +  * Type:Void 
-==== IsVisibleInOverlaySwitcher ​==== +  * Description:​N/​A 
-Gets or sets a value that indicates whether ​the overlay name is displayed in the OverlaySwitcher. + 
-=== Remarks ​=== +== Parameters == 
-For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​IsVisibleInOverlaySwitcher"​ target="​_blank"​>http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​IsVisibleInOverlaySwitcher<​/a> +  * //e// 
-=== Return Value === +    * Type:​EventArgs 
-^ Return ​Type ^ +    * Description:​N/​A 
-| Boolean<!-- System.Boolean -->   ​|+ 
 +<div newline></​div>​ 
 +** {{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. 
 + 
 +<div newline></​div>​ 
 +** {{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 == 
 +<div newline></​div>​ 
 +** {{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 == 
 +<div newline></​div>​ 
 +==== Public Properties ==== 
 +** {{wiki:​PublicProperty.gif|}} Layers **
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> 
-[[#Public Properties|Go Back]] 
-==== Layers ==== 
 This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay. This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Layers" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Layers</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Layers 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:[[ThinkGeo.MapSuite.Core.GeoCollection<​T>[[ThinkGeo.MapSuite.Core.AdornmentLayer, MapSuiteCore,​ Version=9.0.0.0,​ Culture=neutral,​ PublicKeyToken=null]]|GeoCollection<T>]] 
-| [[ThinkGeo.MapSuite.Core.GeoCollection|GeoCollection]]<​[[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]><!-- ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.Core.AdornmentLayer} --> ​  |+ 
 +** {{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 **
  
-<!-- ThinkGeo.MapSuite.WebEdition.AdornmentOverlay --> 
-[[#Public Properties|Go Back]] 
-==== Name ==== 
 Gets or sets the name of the overlay, which will display in the OverlaySwitcher. Gets or sets the name of the overlay, which will display in the OverlaySwitcher.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Name" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Name</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​Name 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:String 
-| String<!-- System.String --> ​  |+ 
 +** {{wiki:​PublicProperty.gif|}} Opacity **
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> 
-[[#Public Properties|Go Back]] 
-==== Opacity ==== 
 Gets or sets the opacity level of the overlay. Gets or sets the opacity level of the overlay.
-=== Remarks ​=== +== Remarks == 
-The &lt;strong&gt;Opacity&lt;/strong&​gt; ​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. +The <strong>Opacity</strong> 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 === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:Single
-| Single<!-- System.Single --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.WebEdition.Overlay --> +** {{wiki:​PublicProperty.gif|}} IsVisibleInOverlaySwitcher ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +Gets or sets a value that indicates whether the overlay name is displayed in the OverlaySwitcher. 
-==== HasTickEvent ​==== +== Remarks == 
-Indicates whether ​the overlay supports tick event. +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#IsVisibleInOverlaySwitcher 
-=== Remarks ​=== +== Return Value == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​HasTickEvent"​ target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​HasTickEvent</​a>​ +  * Type:​Boolean 
-=== Return Value === + 
-^ Return ​Type ^ +** {{wiki:​PublicProperty.gif|}} IsBaseOverlay ** 
-| Boolean<​!-- System.Boolean --> ​  |+ 
 +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 **
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> 
-[[#​Protected Properties|Go Back]] 
-==== OverlayType ==== 
 Gets a string that indicates the overlay type. Gets a string that indicates the overlay type.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OverlayType" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OverlayType</​a>​ +For the most updated Info for this topic, please check it here:​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OverlayType 
-=== Return Value === +== Return Value == 
-^ Return ​Type ^ +  ​* ​Type:String
-| String<​!-- System.String ​--> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.WebEdition.Overlay(overriden) --> +** {{wiki:​ProtectedProperty.gif|}} HasTickEvent ** 
-[[#Protected Properties|Go Back]] + 
-===== Public Events ​===== +Indicates whether the overlay supports tick event. 
-==== Tick ====+== 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. Occurs when the number of milliseconds specified in the AutoRefreshInterval property has elapsed and the page is posted to the server.
-=== Remarks ​=== +== Remarks == 
-For the most updated Info for this topic, please check it here:<a href="http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OnTick.28EventArgs.29" target="​_blank">​http://​wiki.thinkgeo.com/​wiki/​ThinkGeo.MapSuite.WebEdition.AdornmentOverlay#​OnTick.28EventArgs.29</​a>​ +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 === +
-^ Event Arguments ^ +
-| EventArgs<​!-- System.EventArgs --> ​  |+
  
-<!-- ThinkGeo.MapSuite.WebEdition.Overlay --> +Event Arguments:​EventArgs
-[[#Public Events|Go Back]]+
  
-__NOTOC__ 
-[[Category:​WebEdition]] 
-[[Category:​ThinkGeo.MapSuite.WebEdition]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.webedition.adornmentoverlay.1440040135.txt.gz · Last modified: 2015/09/18 03:06 (external edit)

Page Tools