thinkgeo.mapsuite.webedition.maptool
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.webedition.maptool [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.webedition.maptool [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.WebEdition.MapTool ====== | ====== ThinkGeo.MapSuite.WebEdition.MapTool ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| Defines the properties and methods that are shared by all controls on the map. | Defines the properties and methods that are shared by all controls on the map. | ||
| - | === Remarks === | ||
| - | This is the base class that all of the map controls are derived from. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.WebEdition.MapTool]] | + | ***ThinkGeo.MapSuite.WebEdition.MapTool** |
| - | ***[[ThinkGeo.MapSuite.WebEdition.AnimationPanMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.AnimationPanMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.KeyboardMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.MeasureMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.LoadingImageMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.TouchMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.LogoMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.KeyboardMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.MeasureMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.MiniMapMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.LoadingImageMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.MouseCoordinateMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.LogoMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.MouseMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.MouseMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.OverlaySwitcherMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.MouseCoordinateMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.PanZoomBarMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.MiniMapMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.PanZoomMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.PanZoomMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.ScaleLineMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.PanZoomBarMapTool]] |
| - | ***[[ThinkGeo.MapSuite.WebEdition.TouchMapTool]] | + | *[[ThinkGeo.MapSuite.WebEdition.ScaleLineMapTool]] |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} MapTool() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MapTool()|MapTool]] | | | Initialize an instance of the MapTool class. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MapTool(Boolean)|MapTool]] | Boolean | | Initialize an instance of the MapTool class with a boolean value that indicates whether it is enabled. | | + | * //Initialize an instance of the MapTool class.// |
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28.29// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} MapTool(Boolean) ** | ||
| + | |||
| + | * //Initialize an instance of the MapTool class with a boolean value that indicates whether it is enabled.// | ||
| + | == Remarks == | ||
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28Boolean.29// | ||
| + | == Parameters == | ||
| + | * //enabled// | ||
| + | * Type:Boolean | ||
| + | * Description:A boolean value that indicates whether this MapTool is enabled. | ||
| + | <div newline></div> | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ToJson() ** |
| - | | {{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]] | | | Returns a JSON string that represents the map control object. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Returns a JSON string that represents the map control object.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //This method returns a JSON string that instructs the client Javascript to create a specific client object.// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:String |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Enabled|Enabled]] | Boolean | | Gets or sets a value that turns the feature on and off. | | + | * Description:A JSON string that represents the map control. |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | ==== Public Events ==== | + | * //N/A// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#ToString.28.29// | ||
| - | ===== Public Constructors ===== | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:String |
| - | ==== MapTool() ==== | + | * Description:N/A |
| - | Initialize an instance of the MapTool class. | + | |
| - | === Overloads === | + | |
| - | Initialize an instance of the MapTool class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Protected Constructors|Go Back]] | + | == Parameters == |
| - | ==== MapTool(Boolean) ==== | + | <div newline></div> |
| - | Initialize an instance of the MapTool class with a boolean value that indicates whether it is enabled. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | === Overloads === | + | |
| - | Initialize an instance of the MapTool class. | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28Boolean.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MapTool.28Boolean.29</a> | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | enabled | Boolean<!-- System.Boolean --> | A boolean value that indicates whether this MapTool is enabled. | | + | |
| - | [[#Protected Constructors|Go Back]] | + | * //N/A// |
| - | ===== Public Methods ===== | + | == Remarks == |
| - | ==== Equals(Object) ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#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.MapTool#Equals.28Object.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Equals.28Object.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Boolean |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:N/A |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //obj// |
| - | ==== GetHashCode() ==== | + | * 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.MapTool#GetHashCode.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#GetHashCode.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#GetHashCode.28.29// |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#GetType.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#GetType.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Int32 |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== ToJson() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | Returns a JSON string that represents the map control object. | + | |
| - | === Remarks === | + | |
| - | This method returns a JSON string that instructs the client Javascript to create a specific client object. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | A JSON string that represents the map control. | | + | |
| - | === 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.MapTool#GetType.28.29// | ||
| - | <!-- ThinkGeo.MapSuite.WebEdition.MapTool --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Type |
| - | ==== ToString() ==== | + | * 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.MapTool#ToString.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#ToString.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Finalize.28.29// |
| - | ==== Finalize() ==== | + | |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Finalize.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#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]] | + | <div newline></div> |
| - | ==== MemberwiseClone() ==== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | === Remarks === | + | |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MemberwiseClone.28.29" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#MemberwiseClone.28.29</a> | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === 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.MapTool#MemberwiseClone.28.29// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} Enabled ** | ||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Enabled ==== | ||
| Gets or sets a value that turns the feature on and off. | Gets or sets a value that turns the feature on and off. | ||
| - | === Remarks === | + | == Remarks == |
| - | For the most updated Info for this topic, please check it here:<a href="http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Enabled" target="_blank">http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Enabled</a> | + | For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WebEdition.MapTool#Enabled |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Boolean |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.WebEdition.MapTool --> | + | ==== Protected Properties ==== |
| - | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:WebEdition]] | + | |
| - | [[Category:ThinkGeo.MapSuite.WebEdition]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |
thinkgeo.mapsuite.webedition.maptool.1440040135.txt.gz · Last modified: 2015/09/18 03:08 (external edit)