EditableAspMenuNode members

Article
05/27/2015

The EditableAspMenuNode type exposes the following members.

Constructors

	Name	Description
	EditableAspMenuNode

Top

Properties

	Name	Description
	AllowHide	This property indicates whether the editor can save changes to the IsHidden property state. (Note that in the current implementation, the AspMenu supports at most one command, and DisallowDelete=false takes precedence over AllowHide=true; this may change in the future.)
	CustomProperties	If the SiteMapProvider supports custom properties and properties are provided in IEditableSiteMapProvider.GetMenuState, then this property bag will contain the key/value pairs for those properties. If the implementation of the IEditableSiteMapProvider is not supporting custom properties this will always be null.
	DisallowAddChildren	The server code uses this flag to specify that other nodes cannot be moved/added as child nodes of this node. (If it is false, the JavaScript may still prevent the action for some other reason, e.g. because Friendly URL nodes cannot be children of Simple Link nodes.) Taxonomy Nav will set this to true for pinned terms.
	DisallowChangeParent	The server code uses this flag to specify that this node cannot be moved to become a child of a different parent. (If it is false, the JavaScript may still prevent the action for some other reason, e.g. because Friendly URL nodes cannot be children of Simple Link nodes.) Taxonomy Nav will set this to true for pinned terms.
	DisallowDelete	The server code uses this flag to specify that this node cannot be deleted. (If it is false, the JavaScript may still prevent the action for some other reason.)
	DisallowEdit	The server code uses this flag to specify that this node cannot be edited.
	FriendlyUrlSegment	Used only with NodeType=FriendlyUrl. Combined with FriendlyUrlPrefix, this allows the JavaScript to calculate the Friendly URL for a node after it is moved to a new position in the hierarchy. NOTE: We do not plan to allow editing of the FriendlyUrlSegment in the JavaScript UI. Example: "tvs"
	IsDeleted	When the user deletes a nodw, the JavaScript will not really remove it from the tree. Instead, it will set IsDeleted=true to indicate that the server needs to delete it. If there are child nodes, then the server will interpret this as a command to delete all of the child nodes as well.
	IsHidden	The IsHidden property is an editable setting that allows the user to specify that the node should not appear in the navigation menu. This setting may be stored separately for each SiteMapProvider, e.g. allowing the node to appear in the top menu but not the left menu (even though both menus share the same underlying data). Note that there are other reasons why a node may not appear in the menu; these are represented by the IsTrimmed property. During editing, all nodes temporarily become visible so that they can be edited. The editor may allow the user to change the IsHidden state, if the AllowHide property permits it.
	IsTrimmed	Besides the IsHidden user setting, there are a number of other reasons why a node might not be shown in the navigation menu (e.g. security permissions, published/unpublished status, an error state, etc). The IsTrimmed flag represents these other reasons. During editing, all nodes temporarily become visible so that they can be edited, but a special display style is used to indicate the nodes that will disappear again when changes are saved. This style is applied if IsHidden=true or IsTrimmed=true, allowing the display style to be updated immediately (rather than waiting until after the changes are saved).
	Key	An identifier that uniquely identifies the node in the tree. This identifier must be the same key that is exposed by SiteMapNode.Key, IHierarchyData.Path, and the AspMenu's MenuItem.DataPath when bound to a SiteMapDataSource. The actual value is provider dependent and might be a URL, a GUID, an integer, etc. To indicate a newly created node (i.e. in the structure sent from the client to the server), the key should be the empty string. In all other cases, the key must be a unique, nonempty value.
	Nodes	This is an array of immediate child nodes of this node.
	NodeType	One of the enum values documented below
	OmittedChildren	When the tree is trunctated, this counts how many additional children are below this node, i.e. if you move/delete this node, the action will effectively move/delete all those invisible children as well. We could indicate this in the UI e.g. by adding "..." as a suffix to the title when OmittedChildren>0.
	SimpleUrl
	Title	Title displayed in navigation menu (for the active language) Example: "TV's"

Top

Methods

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

Top

See also

Reference

EditableAspMenuNode class

Microsoft.SharePoint.Navigation namespace