User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.measuremaptool

Differences

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

Link to this comparison view

Next revision
Previous revision
thinkgeo.mapsuite.mvcedition.measuremaptool [2015/08/20 03:08]
127.0.0.1 external edit
thinkgeo.mapsuite.mvcedition.measuremaptool [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.MvcEdition.MeasureMapTool ====== ====== ThinkGeo.MapSuite.MvcEdition.MeasureMapTool ======
  
 +{{section>​upgrade_map_suite_to_10.0}}
  
- 
-<!-- Class --> 
 Represents the measure map tool which allows measurements for features. Represents the measure map tool which allows measurements for features.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.MvcEdition.MapTool]] +    *ThinkGeo.MapSuite.MvcEdition.MapTool 
-***[[ThinkGeo.MapSuite.MvcEdition.MeasureMapTool]]+      ***ThinkGeo.MapSuite.MvcEdition.MeasureMapTool**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} MeasureMapTool() ​**
-{{wiki:​PublicMethod.gif|Public Method}}[[#MeasureMapTool()|MeasureMapTool]] ​  ​| ​   |    | Initialize an instance of the MeasureMapTool class. ​  |+
  
 +Initialize an instance of the MeasureMapTool class.
 +== Remarks ==
 +The default MeasureType is Line, and the display system units is Metric by default, also it measures geodesic distance by default.
 +== Parameters ==
 +<div newline></​div>​
 ==== Protected Constructors ==== ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
 ==== 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}}[[#​FromJson(String)|FromJson]] ​  | String ​  | [[ThinkGeo.MapSuite.MvcEdition.MapTool|MapTool]] ​  | Load this object from a json string. ​  | +
-| {{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.MvcEdition.MapTool|MapTool]] ​  | Returns a JSON string that represents the map control object. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +N/A 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks ​== 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | +N/A
-| {{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 ​  | [[ThinkGeo.MapSuite.MvcEdition.MapTool|MapTool]] ​  | Gets or sets a value that turns the feature on and off.   | +  * Description:N/A
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​Geodesic|Geodesic]] ​  | Boolean ​  ​| ​   | Indicate whether to measure geodesic distance. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​MeasureType|MeasureType]] ​  | [[ThinkGeo.MapSuite.MvcEdition.MeasureType|MeasureType]] ​  ​| ​   | Represents the different types of the MeasureMapTool. ​  | +
-| {{wiki:PublicProperty.gif|Public Property}}[[#​MeasureUnitType|MeasureUnitType]] ​  | [[ThinkGeo.MapSuite.MvcEdition.MeasureUnitType|MeasureUnitType]] ​  ​| ​   | Represents the display system units for output measurements. ​  |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} FromJson(String) **
  
-==== Public Events ==== +N/A 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^+== Remarks ​== 
 +N/A
  
-===== Public Constructors ===== +== Return Value == 
-==== MeasureMapTool() ==== +  ​Type:Void 
-Initialize an instance of the MeasureMapTool class. +  Description:N/A
-=== Remarks === +
-The default MeasureType is Line, and the display system units is Metric by default, also it measures geodesic distance by default. +
-=== Parameters === +
-^  Name ^  ​Type ​ ​Description ​^+
  
-[[#Public Constructors|Go Back]] +== Parameters ​== 
-===== Protected Constructors ===== +  * //​jsonString//​ 
-===== Public Methods ===== +    ​* ​Type:String 
-==== Equals(Object) ==== +    ​* Description:​N/​A
-=== Return Value === +
-^ Return ​Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   |+
  
-=== Parameters === +<div newline></​div>​ 
-^  Name ^  Type ^  Description ^ +** {{wiki:​PublicMethod.gif|}} ToString() **
-| obj   | Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-<!-- System.Object --> +N/A 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== FromJson(String) ==== +N/A
-Load this object from a json string. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​+  ​Type:String 
-| jsonString ​  | String<​!-- System.String --> ​  | a json string ​  |+  Description:N/A
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetHashCode() ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   ​|+
  
-=== Parameters === +N/A 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +N/A
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Boolean 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --+<div newline></​div
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== ToJson() ==== +
-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 ​== 
 +N/A
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type Description ​+
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- System.Object --> +N/A 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-===== Protected Methods ===== +N/A
-==== Finalize() ==== +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​ ​Description ​^+  ​Type:Type 
 +  Description:N/A
  
-<!-- System.Object --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-==== MemberwiseClone() ​==== +==== Protected Methods ​==== 
-=== Return Value === +** {{wiki:​ProtectedMethod.gif|}} Finalize() **
-^ Return Type ^ Description ^ +
-| Object<​!-- System.Object --> ​  ​| ​   ​|+
  
-=== Parameters === +N/A 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +N/A
  
-<!-- System.Object --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-===== Public Properties ===== +  * Description:​N/​A
-==== Enabled ==== +
-Gets or sets a value that turns the feature on and off. +
-=== Return Value === +
-^ Return ​Type ^ +
-| Boolean<​!-- System.Boolean --> ​  |+
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MapTool --+== Parameters == 
-[[#Public Properties|Go Back]] +<div newline></​div
-==== Geodesic ​==== +** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** 
-Indicate whether to measure geodesic distance. + 
-=== Return Value === +N/A 
-^ Return Type ^ +== Remarks ​== 
-| Boolean<​!-- System.Boolean --> ​  |+N/A 
 + 
 +== Return Value == 
 +  * Type:​Object 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +<div newline></​div>​ 
 +==== Public Properties ​==== 
 +** {{wiki:​PublicProperty.gif|}} MeasureType **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MeasureMapTool --> 
-[[#Public Properties|Go Back]] 
-==== MeasureType ==== 
 Represents the different types of the MeasureMapTool. Represents the different types of the MeasureMapTool.
-=== Return Value === +== Remarks == 
-^ Return ​Type +N/A 
-[[ThinkGeo.MapSuite.MvcEdition.MeasureType|MeasureType]]<!-- ThinkGeo.MapSuite.MvcEdition.MeasureType --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.MeasureType|MeasureType]] 
 + 
 +** {{wiki:​PublicProperty.gif|}} MeasureUnitType **
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MeasureMapTool --> 
-[[#Public Properties|Go Back]] 
-==== MeasureUnitType ==== 
 Represents the display system units for output measurements. Represents the display system units for output measurements.
-=== Return Value === +== Remarks == 
-^ Return ​Type +N/A 
-[[ThinkGeo.MapSuite.MvcEdition.MeasureUnitType|MeasureUnitType]]<!-- ThinkGeo.MapSuite.MvcEdition.MeasureUnitType --> ​  |+== Return Value == 
 +  ​* ​Type:[[ThinkGeo.MapSuite.MvcEdition.MeasureUnitType|MeasureUnitType]]
  
-<!-- ThinkGeo.MapSuite.MvcEdition.MeasureMapTool --> +** {{wiki:​PublicProperty.gif|}} Geodesic ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +Indicate whether to measure geodesic distance
-===== Public Events ====+== Remarks == 
-__NOTOC__ +N/A 
-[[Category:​MvcEdition]] +== Return Value == 
-[[Category:​ThinkGeo.MapSuite.MvcEdition]] +  * Type:​Boolean 
-[[Category:​UpdateDocumentation]]+ 
 +** {{wiki:​PublicProperty.gif|}} Enabled ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return Value == 
 +  * Type:​Boolean 
 + 
 +==== Protected Properties ==== 
 +==== Public Events ====
  
thinkgeo.mapsuite.mvcedition.measuremaptool.1440040131.txt.gz · Last modified: 2015/09/21 03:34 (external edit)