thinkgeo.mapsuite.mvcedition.contextmenu
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.contextmenu [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.MvcEdition.ContextMenu ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | This class represents a right-click shortcut menu used in the map control. | ||
| - | === Remarks === | ||
| - | The ContextMenu class represents a right-click shortcut menu which displays when a user right-clicks on a map or an element of a map. Shortcut menus are typically used to combine different menu items that are useful for the user, given the context of the application. | ||
| - | |||
| - | Use the <strong>CssClass</strong> property to customize the appearance of the context menu. The <strong>MenuItems</strong> property holds the items in the context menu. | ||
| - | |||
| - | You can set the <strong>Width</strong> of the context menu, and the height of the context menu will be automatically ajusted to fit all of the menu's items. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.ContextMenu]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ContextMenu()|ContextMenu]] | | | Initializes a new instance of the ContextMenu class with no menu items specified. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ContextMenu(String, Int32)|ContextMenu]] | String, Int32 | | Initializes a new instance of the ContextMenu class with the specified identifier and width. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ContextMenu(String, Int32, String)|ContextMenu]] | String, Int32, String | | Initializes a new instance of the ContextMenu class with the identifier, width and CSS class string. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]] | | | Creates a deep copy of this ContextMenu object. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#FromJson(String)|FromJson]] | String | | 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]] | | | Returns a JSON string that contains information for creating the context menu at the client side. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CssClass|CssClass]] | String | | Gets or sets the CSS class of the context menu. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | | Gets the identifier of the ContextMenu object. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#MenuItems|MenuItems]] | [[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection|GeoKeyedCollection]]<[[ThinkGeo.MapSuite.MvcEdition.ContextMenuItem|ContextMenuItem]]> | | Gets the menu item collection of the context menu. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Width|Width]] | Int32 | | Gets or sets the width of the context menu. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== ContextMenu() ==== | ||
| - | Initializes a new instance of the ContextMenu class with no menu items specified. | ||
| - | === Overloads === | ||
| - | Initializes a new instance of the ContextMenu class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ContextMenu(String, Int32) ==== | ||
| - | Initializes a new instance of the ContextMenu class with the specified identifier and width. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The key of the context menu in string format. | | ||
| - | | width | Int32<!-- System.Int32 --> | The width of the context menu. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ==== ContextMenu(String, Int32, String) ==== | ||
| - | Initializes a new instance of the ContextMenu class with the identifier, width and CSS class string. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | id | String<!-- System.String --> | The key of the context menu in string format. | | ||
| - | | width | Int32<!-- System.Int32 --> | The width of the context menu. | | ||
| - | | cssClass | String<!-- System.String --> | The CSS class for the context menu. | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== CloneDeep() ==== | ||
| - | Creates a deep copy of this ContextMenu object. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.ContextMenu|ContextMenu]]<!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | A deep copy of the ContextMenu object. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== FromJson(String) ==== | ||
| - | Load this object from a json string. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | jsonString | String<!-- System.String --> | a json string | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToJson() ==== | ||
| - | Returns a JSON string that contains information for creating the context menu at the client side. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | A string for creating the context menu at the client side. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== CssClass ==== | ||
| - | Gets or sets the CSS class of the context menu. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Id ==== | ||
| - | Gets the identifier of the ContextMenu object. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== MenuItems ==== | ||
| - | Gets the menu item collection of the context menu. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection|GeoKeyedCollection]]<[[ThinkGeo.MapSuite.MvcEdition.ContextMenuItem|ContextMenuItem]]><!-- ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection{ThinkGeo.MapSuite.MvcEdition.ContextMenuItem} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== Width ==== | ||
| - | Gets or sets the width of the context menu. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ContextMenu --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MvcEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mvcedition.contextmenu.1440040131.txt.gz ยท Last modified: 2015/09/21 03:32 (external edit)
