ExplorerTreeNode Class

Represents a node in the Model Explorer tree view.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.Windows.Forms.TreeNode
      Microsoft.VisualStudio.Modeling.Shell.ExplorerTreeNode
        Microsoft.VisualStudio.Modeling.Shell.ElementTreeNode
        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 MustInherit Class ExplorerTreeNode _
    Inherits TreeNode _
    Implements IDisposable

public abstract class ExplorerTreeNode : TreeNode, 
    IDisposable

public ref class ExplorerTreeNode abstract : public TreeNode, 
    IDisposable

[<AbstractClass>]
type ExplorerTreeNode =  
    class 
        inherit TreeNode 
        interface IDisposable 
    end

public abstract class ExplorerTreeNode extends TreeNode implements IDisposable

The ExplorerTreeNode type exposes the following members.

Constructors

	Name	Description
	ExplorerTreeNode	Initializes a new instance of the ExplorerTreeNode class.

Top

Properties

	Name	Description
	BackColor	Gets or sets the background color of the tree node. (Inherited from TreeNode.)
	Bounds	Gets the bounds of the tree node. (Inherited from TreeNode.)
	Checked	Gets or sets a value indicating whether the tree node is in a checked state. (Inherited from TreeNode.)
	Container	The explorer tree container that hosts this node.
	ContextMenu	Gets the shortcut menu that is associated with this tree node. (Inherited from TreeNode.)
	ContextMenuStrip	Gets or sets the shortcut menu associated with this tree node. (Inherited from TreeNode.)
	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
	Disposed	True if this node has been explicitly disposed.
	FirstNode	Gets the first child tree node in the tree node collection. (Inherited from TreeNode.)
	ForeColor	Gets or sets the foreground color of the tree node. (Inherited from TreeNode.)
	FullPath	Gets the path from the root tree node to the current tree node. (Inherited from TreeNode.)
	Handle	Gets the handle of the tree node. (Inherited from TreeNode.)
	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.)
	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.)
	Index	Gets the position of the tree node in the tree node collection. (Inherited from TreeNode.)
	IsEditing	Gets a value indicating whether the tree node is in an editable state. (Inherited from TreeNode.)
	IsExpanded	Gets a value indicating whether the tree node is in the expanded state. (Inherited from TreeNode.)
	IsSelected	Gets a value indicating whether the tree node is in the selected state. (Inherited from TreeNode.)
	IsVisible	Gets a value indicating whether the tree node is visible or partially visible. (Inherited from TreeNode.)
	KeepNode	Gets or sets the node to keep when you update (prune) the navigation tree.
	LastNode	Gets the last child tree node. (Inherited from TreeNode.)
	Level	Gets the zero-based depth of the tree node in the TreeView control. (Inherited from TreeNode.)
	Name	Gets or sets the name of the tree node. (Inherited from TreeNode.)
	NextNode	Gets the next sibling tree node. (Inherited from TreeNode.)
	NextVisibleNode	Gets the next visible tree node. (Inherited from TreeNode.)
	NodeFont	Gets or sets the font that is used to display the text on the tree node label. (Inherited from TreeNode.)
	Nodes	Gets the collection of TreeNode objects assigned to the current tree node. (Inherited from TreeNode.)
	Parent	Gets the parent tree node of the current tree node. (Inherited from TreeNode.)
	PrevNode	Gets the previous sibling tree node. (Inherited from TreeNode.)
	PrevVisibleNode	Gets the previous visible tree node. (Inherited from TreeNode.)
	RepresentedElement	The ModelElement that this node represents (if any).
	RepresentedRole	The Domain Role that this node represents (if any).
	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.)
	SelectedImageKey	Gets or sets the key of the image displayed in the tree node when it is in a selected state. (Inherited from TreeNode.)
	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.)
	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.)
	Tag	Gets or sets the object that contains data about the tree node. (Inherited from TreeNode.)
	Text	Gets or sets the text displayed in the label of the tree node. (Inherited from TreeNode.)
	ToolTipText	Gets or sets the text that appears when the mouse pointer hovers over a TreeNode. (Inherited from TreeNode.)
	TreeView	Gets the parent tree view that the tree node is assigned to. (Inherited from TreeNode.)

Top

Methods

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

Top

Explicit Interface Implementations

	Name	Description
	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.

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