Share via

RoleGroupTreeNode Class

  • Article

Represents the node that contains the child roles for a parent role in the navigation tree for Model Explorer.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.Windows.Forms.TreeNode
      Microsoft.VisualStudio.Modeling.Shell.ExplorerTreeNode
        Microsoft.VisualStudio.Modeling.Shell.RoleGroupTreeNode

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Public Class RoleGroupTreeNode _
    Inherits ExplorerTreeNode

public class RoleGroupTreeNode : ExplorerTreeNode

public ref class RoleGroupTreeNode : public ExplorerTreeNode

type RoleGroupTreeNode =  
    class 
        inherit ExplorerTreeNode 
    end

public class RoleGroupTreeNode extends ExplorerTreeNode

The RoleGroupTreeNode type exposes the following members.

Constructors

  Name Description
Public method RoleGroupTreeNode Initializes a new instance of the RoleGroupTreeNode class.

Top

Properties

  Name Description
Public property BackColor Gets or sets the background color of the tree node. (Inherited from TreeNode.)
Public property Bounds Gets the bounds of the tree node. (Inherited from TreeNode.)
Public property Checked Gets or sets a value indicating whether the tree node is in a checked state. (Inherited from TreeNode.)
Public property Container The explorer tree container that hosts this node. (Inherited from ExplorerTreeNode.)
Public property ContextMenu Gets the shortcut menu that is associated with this tree node. (Inherited from TreeNode.)
Public property ContextMenuStrip Gets or sets the shortcut menu associated with this tree node. (Inherited from TreeNode.)
Public property DefaultImageIndex Get or set the index into the TreeView image list to be used for the icon representing this node if not overridden by an icon based on the node content (Inherited from ExplorerTreeNode.)
Public property Disposed True if this node has been explicitly disposed. (Inherited from ExplorerTreeNode.)
Public property FirstNode Gets the first child tree node in the tree node collection. (Inherited from TreeNode.)
Public property ForeColor Gets or sets the foreground color of the tree node. (Inherited from TreeNode.)
Public property FullPath Gets the path from the root tree node to the current tree node. (Inherited from TreeNode.)
Public property Handle Gets the handle of the tree node. (Inherited from TreeNode.)
Public property ImageIndex Gets or sets the image list index value of the image displayed when the tree node is in the unselected state. (Inherited from TreeNode.)
Public property ImageKey Gets or sets the key for the image associated with this tree node when the node is in an unselected state. (Inherited from TreeNode.)
Public property Index Gets the position of the tree node in the tree node collection. (Inherited from TreeNode.)
Public property IsEditing Gets a value indicating whether the tree node is in an editable state. (Inherited from TreeNode.)
Public property IsExpanded Gets a value indicating whether the tree node is in the expanded state. (Inherited from TreeNode.)
Public property IsSelected Gets a value indicating whether the tree node is in the selected state. (Inherited from TreeNode.)
Public property IsVisible Gets a value indicating whether the tree node is visible or partially visible. (Inherited from TreeNode.)
Public property KeepNode Gets or sets the node to keep when you update (prune) the navigation tree. (Inherited from ExplorerTreeNode.)
Public property LastNode Gets the last child tree node. (Inherited from TreeNode.)
Public property Level Gets the zero-based depth of the tree node in the TreeView control. (Inherited from TreeNode.)
Public property Name Gets or sets the name of the tree node. (Inherited from TreeNode.)
Public property NextNode Gets the next sibling tree node. (Inherited from TreeNode.)
Public property NextVisibleNode Gets the next visible tree node. (Inherited from TreeNode.)
Public property NodeFont Gets or sets the font that is used to display the text on the tree node label. (Inherited from TreeNode.)
Public property Nodes Gets the collection of TreeNode objects assigned to the current tree node. (Inherited from TreeNode.)
Public property Parent Gets the parent tree node of the current tree node. (Inherited from TreeNode.)
Public property PrevNode Gets the previous sibling tree node. (Inherited from TreeNode.)
Public property PrevVisibleNode Gets the previous visible tree node. (Inherited from TreeNode.)
Public property RepresentedElement The ModelElement that this node represents (if any). (Inherited from ExplorerTreeNode.)
Public property RepresentedRole The 1..* role that this node represents (Overrides ExplorerTreeNode.RepresentedRole.)
Public property RoleInfo Gets the DomainRoleInfo object for the node.
Public property SelectedImageIndex Gets or sets the image list index value of the image that is displayed when the tree node is in the selected state. (Inherited from TreeNode.)
Public property SelectedImageKey Gets or sets the key of the image displayed in the tree node when it is in a selected state. (Inherited from TreeNode.)
Public property StateImageIndex Gets or sets the index of the image that is used to indicate the state of the TreeNode when the parent TreeView has its CheckBoxes property set to false. (Inherited from TreeNode.)
Public property StateImageKey Gets or sets the key of the image that is used to indicate the state of the TreeNode when the parent TreeView has its CheckBoxes property set to false. (Inherited from TreeNode.)
Public property Tag Gets or sets the object that contains data about the tree node. (Inherited from TreeNode.)
Public property Text Gets or sets the text displayed in the label of the tree node. (Inherited from TreeNode.)
Public property ToolTipText Gets or sets the text that appears when the mouse pointer hovers over a TreeNode. (Inherited from TreeNode.)
Public property TreeView Gets the parent tree view that the tree node is assigned to. (Inherited from TreeNode.)

Top

Methods

  Name Description
Public method BeginEdit Initiates the editing of the tree node label. (Inherited from TreeNode.)
Public method Clone Copies the tree node and the entire subtree rooted at this tree node. (Inherited from TreeNode.)
Public method Collapse() Collapses the tree node. (Inherited from TreeNode.)
Public method Collapse(Boolean) Collapses the TreeNode and optionally collapses its children. (Inherited from TreeNode.)
Public method CreateObjRef Security Critical. Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Protected method Deserialize Loads the state of the TreeNode from the specified SerializationInfo. (Inherited from TreeNode.)
Public method Dispose() (Inherited from ExplorerTreeNode.)
Protected method Dispose(Boolean) Override point for performing whatever Dispose action is required by subclass (Inherited from ExplorerTreeNode.)
Public method EndEdit Ends the editing of the tree node label. (Inherited from TreeNode.)
Public method EnsureVisible Ensures that the tree node is visible, expanding tree nodes and scrolling the tree view control as necessary. (Inherited from TreeNode.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Expand Expands the tree node. (Inherited from TreeNode.)
Public method ExpandAll Expands all the child tree nodes. (Inherited from TreeNode.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetLifetimeService Security Critical. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public method GetNodeCount Returns the number of child tree nodes. (Inherited from TreeNode.)
Protected method GetRepresentedElement Get the ModelElement that this node represents, if any. (Inherited from ExplorerTreeNode.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method InitializeLifetimeService Security Critical. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method MemberwiseClone(Boolean) Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected method ProvideNodeText Supplies the text for the node. (Overrides ExplorerTreeNode.ProvideNodeText().)
Public method Remove Removes the current tree node from the tree view control. (Inherited from TreeNode.)
Protected method Serialize Saves the state of the TreeNode to the specified SerializationInfo. (Inherited from TreeNode.)
Protected method SetRepresentedElement Set the ModelElement that this node represents. (Inherited from ExplorerTreeNode.)
Public method Toggle Toggles the tree node to either the expanded or collapsed state. (Inherited from TreeNode.)
Public method ToString Returns a string that represents the current object. (Inherited from TreeNode.)
Public method Update Force an update of the text and icon of the node. By default this sets the default image and updates the node text by using UpdateNodeText() (Inherited from ExplorerTreeNode.)
Public method UpdateNodeText Updates the text for the node. (Inherited from ExplorerTreeNode.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ISerializable.GetObjectData Populates a serialization information object with the data needed to serialize the TreeNode. (Inherited from TreeNode.)

Top

Remarks

DSL Explorer is derived from Model Explorer.

This node has a one-to-many embedding domain relationship between the parent role and its child roles. The property display name that is assigned to the child role (PropertyDisplayName) determines the text that appears beside the node.

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

Microsoft.VisualStudio.Modeling.Shell Namespace