Share via


ScopeNode Class

 

Represents a node that defines a scope in the MMC scope namespace.

Namespace:   Microsoft.ManagementConsole
Assembly:  Microsoft.ManagementConsole (in Microsoft.ManagementConsole.dll)

Inheritance Hierarchy

System.Object
  Microsoft.ManagementConsole.Node
    Microsoft.ManagementConsole.ScopeNode

Syntax

public class ScopeNode : Node
public ref class ScopeNode : Node
type ScopeNode = 
    class
        inherit Node
    end
Public Class ScopeNode
    Inherits Node

Constructors

Name Description
System_CAPS_pubmethod ScopeNode()

Initializes a new instance of the ScopeNode class.

System_CAPS_pubmethod ScopeNode(Boolean)

Initializes a new instance of the ScopeNode class using a flag that determines whether the scope node is created with the Expand icon enabled.

System_CAPS_pubmethod ScopeNode(Guid)

Initializes a new instance of the ScopeNode class using a GUID that specifies the type of the scope node.

System_CAPS_pubmethod ScopeNode(Guid, Boolean)

Initializes a new instance of the ScopeNode class using a GUID that specifies the type of the scope node and a flag that determines whether the scope node is created with the Expand icon enabled.

Properties

Name Description
System_CAPS_pubproperty ActionsPaneHelpItems

Gets the actions that are available on the help menu when the node has focus.

System_CAPS_pubproperty ActionsPaneItems

Gets the actions that should be available when the node has focus.

System_CAPS_pubproperty Children

Gets the children of the scope node.

System_CAPS_pubproperty DefaultDragAndDropVerb

Gets or sets the default drag-and-drop operation to be performed when a data object is dropped on this node.

System_CAPS_pubproperty DisplayName

Gets or sets the display name for the node. (Inherited from Node.)

System_CAPS_pubproperty EnabledStandardVerbs

Gets or sets the bits indicating which standard verbs are enabled for the scope node.

System_CAPS_pubproperty HelpTopic

Gets or sets the help topic for the node.

System_CAPS_protproperty Id

Gets the internally generated integer that uniquely identifies the Node instance at runtime. (Inherited from Node.)

System_CAPS_pubproperty ImageIndex

Gets or sets the image index for the node. This is an index of the small and large images in the instance of the snap-in class that is related to the node. (Inherited from Node.)

System_CAPS_pubproperty LanguageIndependentName

Gets or sets an identifier that is locale-independent and remains constant across MMC sessions. This property is used for persistence.

System_CAPS_pubproperty NodeType

Gets a GUID that represents the MMC node type of the scope node. This data is used by the MMC extension mechanism.

System_CAPS_pubproperty Parent

Gets the parent node of the scope node.

System_CAPS_pubproperty SelectedImageIndex

Gets or sets the index of the image that is displayed when the node has focus.

System_CAPS_pubproperty SharedData

Gets the shared data for the scope node. Shared data is used to publish context to extension snap-ins.

System_CAPS_pubproperty SnapIn

Gets the instance of the snap-in that is associated with the node. (Inherited from Node.)

System_CAPS_pubproperty SubItemDisplayNames

Gets or sets the collection of sub-item display names for the node. This collection is used if the node appears in a list view. (Inherited from Node.)

System_CAPS_pubproperty Tag

Gets or sets custom information that is associated with the node. (Inherited from Node.)

System_CAPS_pubproperty ViewDescriptions

Gets or sets the view descriptions that are supported by the scope node.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetAllowedClipboardFormatIdsForPaste()

Gets the set of clipboard formats that can be pasted on this node.

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod OnAction(Action, AsyncStatus)

Performs application-specific handling when an action is triggered for the scope node.

System_CAPS_protmethod OnAddPropertyPages(PropertyPageCollection)

Adds the properties to be displayed for the scope node when the Properties verb is triggered.

System_CAPS_protmethod OnCut(AsyncStatus)

Removes the scope node when it has been successfully pasted elsewhere after the Cut verb is triggered.

System_CAPS_protmethod OnDelete(SyncStatus)

Removes the scope node when the Delete verb is triggered.

System_CAPS_protmethod OnExpand(AsyncStatus)

Displays the children of the scope node when the scope node is expanded.

System_CAPS_protmethod OnExpandFromLoad(SyncStatus)

Displays the children of the scope node when the scope node is expanded synchronously with MMC. MMC expands nodes to the last node that was selected when the console file was saved.

System_CAPS_protmethod OnGetSharedData(WritableSharedDataItem, SyncStatus)

Provides published data for a scope node’s shared data item when the data is requested.

System_CAPS_protmethod OnPaste(SharedData, DragAndDropVerb, SyncStatus)

Pastes data into the scope node when the Paste verb is triggered.

System_CAPS_protmethod OnPrint(SyncStatus)

Prints the scope node when the Print verb is triggered.

System_CAPS_protmethod OnRefresh(AsyncStatus)

Updates the scope node when the Refresh verb is triggered.

System_CAPS_protmethod OnRename(String, SyncStatus)

Changes the name of the scope node when the Rename verb is triggered.

System_CAPS_protmethod OnSharedDataChangeRequested(WritableSharedDataItem, Byte[], AsyncStatus)

Updates data for a scope node’s shared data item when a change is requested.

System_CAPS_protmethod OnSyncAction(SyncAction, SyncStatus)

Performs application-specific handling when an action that runs synchronous to MMC is triggered for the scope node.

System_CAPS_pubmethod SetAllowedClipboardFormatIdsForPaste(String[])

Updates the set of clipboard formats that can used for pasting on the scope node.

System_CAPS_pubmethod ShowPropertySheet(String)

Displays a property sheet for the scope node. This method brings an existing sheet to the foreground.

System_CAPS_pubmethod ShowPropertySheet(String, Boolean)

Displays a property sheet for the scope node and uses a flag to indicate whether the APPLY button is to be hidden. This method brings an existing sheet to the foreground.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Events

Name Description
System_CAPS_pubevent ActionsActivated

Snap-ins can subscribe to this event to get called to supply actions for the scope node in the event handler.

System_CAPS_pubevent ActionsDeactivated

Snap-ins can subscribe to this event in conjunction with ActionsActivated to clean-up or remove actions on this scope node when the actions are no longer needed.

Remarks

Since the scope namespace is hierarchical, a scope node has children. A scope node's children are specified in the Children property. Scope nodes support additional UI elements including a selected image and have the ability to show an expansion glyph to signify that the node has child elements. These additional UI elements are exposed as properties on the scope node.

Each scope node may have a set of view descriptions, which are specified in the ViewDescriptions property.

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

Microsoft.ManagementConsole Namespace

Return to top