thinkgeo.mapsuite.mvcedition.keyboardmaptool
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.keyboardmaptool [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mvcedition.keyboardmaptool [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MvcEdition.KeyboardMapTool ====== | ====== ThinkGeo.MapSuite.MvcEdition.KeyboardMapTool ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| Determines whether the map can be operated by keyboard. | Determines whether the map can be operated by keyboard. | ||
| - | === Remarks === | ||
| - | The <strong>KeyboardMapTool</strong> map control determines whether you can operate the map by keyboard. Set the <strong>Enabled</strong> property to true to enable the keyboard support of the map. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.MvcEdition.MapTool]] | + | *ThinkGeo.MapSuite.MvcEdition.MapTool |
| - | ***[[ThinkGeo.MapSuite.MvcEdition.KeyboardMapTool]] | + | ***ThinkGeo.MapSuite.MvcEdition.KeyboardMapTool** |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} KeyboardMapTool() ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#KeyboardMapTool()|KeyboardMapTool]] | | | Initializes a new instance of the KeyboardMapTool class. | | + | |
| + | * //Initializes a new instance of the KeyboardMapTool class.// | ||
| + | == Remarks == | ||
| + | * //Use this constructor to create and initialize a new instance of the KeyboardMapTool class.// | ||
| + | == 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}}[[#PanPixels|PanPixels]] | Int32 | | Gets or sets the number of pixels that are shifted by each keyboard-based panning operation. | | + | |
| - | ==== 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 == |
| - | ==== KeyboardMapTool() ==== | + | * Type:Void |
| - | Initializes a new instance of the KeyboardMapTool class. | + | * Description:N/A |
| - | === Remarks === | + | |
| - | Use this constructor to create and initialize a new instance of the <strong>KeyboardMapTool</strong> class. | + | |
| - | === 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. | + | == Parameters == |
| - | === Return Value === | + | <div newline></div> |
| - | ^ Return Type ^ | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | | Boolean<!-- System.Boolean --> | | + | |
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} PanPixels ** | ||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MapTool --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== PanPixels ==== | ||
| Gets or sets the number of pixels that are shifted by each keyboard-based panning operation. | Gets or sets the number of pixels that are shifted by each keyboard-based panning operation. | ||
| - | === Remarks === | + | == Remarks == |
| The value of this property determines how many pixels to shift when using the arrow keys to pan. | The value of this property determines how many pixels to shift when using the arrow keys to pan. | ||
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:Int32 |
| - | | Int32<!-- System.Int32 --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MvcEdition.KeyboardMapTool --> | + | ** {{wiki:PublicProperty.gif|}} Enabled ** |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | N/A |
| - | ===== Public Events ===== | + | == Remarks == |
| - | __NOTOC__ | + | N/A |
| - | [[Category:MvcEdition]] | + | == Return Value == |
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | + | * Type:Boolean |
| - | [[Category:UpdateDocumentation]] | + | |
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.mvcedition.keyboardmaptool.1440040131.txt.gz · Last modified: 2015/09/21 03:33 (external edit)