EditableAspMenuState members

The EditableAspMenuState type exposes the following members.

Constructors

  Name Description
Public method EditableAspMenuState

Top

Properties

  Name Description
Public property FriendlyUrlPrefix This specifies the Friendly URL prefix for starting node. For e.g. the TopNav menu which always starts at the top of the tree, the FriendlyUrlPrefix will typically be equal to SPWebPrefix. Suppose the starting node is "Products" (i.e. OmittedParentLevels=1) -- to obtain the Friendly URL for node "B" whose parent is node "A", the JavaScript would concatenate these strings: FriendlyUrlPrefix + A.FriendlyUrlSegment + "/" + B.FriendlyUrlSegment i.e. "https://contoso.com/sites/site1/web1/products/" + "tvs" + "/" + "cameras" Example: "https://contoso.com/sites/site1/web1/Products/"
Public property Nodes This is the collection of child nodes under the starting node. The starting node is represented implicitly by the various fields above.
Public property OmittedParentLevels If the menu's starting node is the root of the navigation tree, then OmittedParentLevels is 0. Otherwise, the menu starts from a child node, and OmittedParentLevels indicates how many levels deep we are (i.e. how many parents we must follow to get to the root). The UI could indicate this e.g. by displaying "..." above the first menu link.
Public property SimpleUrl
Public property SPSitePrefix If you want the "Try Link" command to work properly with relative links such as "~sitecollection/Pages/MyPage.aspx", this prefix defines the text that should be substituted for "~sitecollection/. Example: "https://contoso.com/sites/site1/"
Public property SPWebPrefix If you want the "Try Link" command to work properly with relative links such as "~site/Pages/MyPage.aspx", this prefix defines the text that should be substituted for "~site/. Example: "https://contoso.com/sites/site1/web1/"
Public property StartingNodeKey This key identifies the starting node within the navigation tree. This is the same kind of key as EditableAspMenuNode.Key.
Public property StartingNodeTitle Sometimes the AspMenu control shows the starting node and sometimes it does not (see AspMenu.AdjustForShowStartingNode and SiteMapDataSource.ShowStartingNode for background on this). Its title is included here so that the JavaScript could display it. Example: "Document Center"
Public property Version This is an arbitrary text string that the server uses to detect external changes (referred to in SharePoint as "save conflicts"). For example, it could be a change timestamp for the database, or a monotonically increasing version number, etc. Example: "2009-06-15T20:45:30Z"

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)

Top

See also

Reference

EditableAspMenuState class

Microsoft.SharePoint.Navigation namespace