ConsoleNode Class

The basic structure used to represent the Console menu. Each ConsoleNode object can optionally have child ConsoleNode objects and associated console ConsoleAction objects.

Inheritance Hierarchy

System.Object
  Microsoft.SharePoint.Publishing.WebControls.ConsoleNode
    Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions.ModifyWebPartsNode
    Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions.ReportsNode

Namespace:  Microsoft.SharePoint.Publishing.WebControls
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
<SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel := True)> _
<SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel := True)> _
Public Class ConsoleNode
'Usage
Dim instance As ConsoleNode
[SharePointPermissionAttribute(SecurityAction.LinkDemand, ObjectModel = true)]
[SharePointPermissionAttribute(SecurityAction.InheritanceDemand, ObjectModel = true)]
public class ConsoleNode

Remarks

Action user interfaces such as the Editing menu, Quick Access button, or Site Actions menu present various actions to the user. Each of these has an instance of the ConsoleDataSource object that provides a hierarchical collection of ConsoleNode objects. Some ConsoleNode objects implement the ConsoleAction class in a specific way.

When the Action property for a ConsoleNode is defined as a ConsoleAction, the properties of the ConsoleAction, such as DisplayText and href, are used as properties with the same names in the ConsoleNode.

When a property, such as ImageUrl, is defined in both a ConsoleNode object and a ConsoleAction object that the ConsoleNode references, the value specified in the ConsoleNode overrides the value in the referenced ConsoleAction if the corresponding Boolean value has been set. In this case, setting the [UseActionImageUrl] property to False causes the ConsoleNode to override the ConsoleAction property.

Each instance of this class represents an action or a submenu. For example, in the Site Actions menu, if a ConsoleNode has at least one child in the ChildConsoleNodes collection, it appears as the root of a submenu with the child ConsoleNodes appearing in the submenu. If the ConsoleNode has no children, it appears as a clickable action.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

ConsoleNode Members

Microsoft.SharePoint.Publishing.WebControls Namespace