View Class

 

This is the base class for defining MMC views. Snap-in developers provide specializations that are derived from this class. Instances of this class are created on the same thread as the snap-in. There is a derived View class for each type of supported view.

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

Inheritance Hierarchy

System.Object
  Microsoft.ManagementConsole.View
    Microsoft.ManagementConsole.FormView
    Microsoft.ManagementConsole.HtmlView
    Microsoft.ManagementConsole.MessageView
    Microsoft.ManagementConsole.MmcListView

Syntax

public abstract class View
public ref class View abstract 
[<AbstractClass>]
type View = class end
Public MustInherit Class View

Properties

Name Description
System_CAPS_pubproperty ActionsPaneItems

Gets the set of selection-independent actions that apply to the entire view. To specify actions that apply to the selected items in the view, use the selection data property ActionsPaneItems instead.

System_CAPS_pubproperty DescriptionBarText

Gets or sets the text that appears on the description bar for the view that follows the scope node display name in the description bar.

System_CAPS_pubproperty IsModified

Gets or sets a flag that indicates that the view has data that needs to be saved.

System_CAPS_pubproperty ModeActionsPaneItems

Gets the set of actions used to configure the visual modes for the view. These actions appear in the actions pane and in various menus on locations that are reserved for this purpose.

System_CAPS_pubproperty ScopeNode

Gets the scope node with which this view is associated.

System_CAPS_pubproperty SelectionData

Gets the selection data for the view.

System_CAPS_pubproperty SharedTag

Gets or sets an object that is shared across view instances of a particular MDI child.

System_CAPS_pubproperty SnapIn

Gets the snap-in associated with the view.

System_CAPS_pubproperty ViewDescriptionTag

Gets the tag that was set on the associated view description.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod ExpandScopeNode(ScopeNode)

Expands the specified scope node.

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod IsScopeNodeVisuallyExpanded(ScopeNode)

This API supports the product infrastructure and is not intended to be used directly from your code. Indicates whether the specified node is expanded.

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_protmethod OnAction(Action, AsyncStatus)

Handles the execution of a selection-independent action.

System_CAPS_protmethod OnAddPropertyPages(PropertyPageCollection)

Called to add property pages to a property sheet.

System_CAPS_protmethod OnCut(Object, AsyncStatus)

Called so that the snap-in can cut items from the given selection after it has been pasted elsewhere.

System_CAPS_protmethod OnDelete(SyncStatus)

Called when the Delete standard verb is triggered.

System_CAPS_protmethod OnGetSharedData(Object, WritableSharedDataItem, SyncStatus)

Handles a request to provide data for a published data item that was designated as one that requires a callback.

System_CAPS_protmethod OnHide()

Called when a view is hidden in the UI.

System_CAPS_protmethod OnInitialize(AsyncStatus)

Allows snap-in code to perform custom view initialization.

System_CAPS_protmethod OnLoadCustomData(AsyncStatus, Byte[])

Allows the snap-in to receive previously stored binary data that is contained in the console file.

System_CAPS_protmethod OnModeAction(Action, AsyncStatus)

Handles the execution of an action that is used to configure view modes.

System_CAPS_protmethod OnPaste(SharedData, DragAndDropVerb, SyncStatus)

Invoked when data is pasted onto the current selection.

System_CAPS_protmethod OnPrint(SyncStatus)

Called when the Print standard verb is triggered.

System_CAPS_protmethod OnRefresh(AsyncStatus)

Called when the Refresh standard verb is triggered.

System_CAPS_protmethod OnRename(String, SyncStatus)

Called when the Rename standard verb is triggered.

System_CAPS_protmethod OnSaveCustomData(SyncStatus)

Allows the view to store binary data in the console file.

System_CAPS_protmethod OnSelectionAction(Action, AsyncStatus)

Handles the execution of a selection-dependent action.

System_CAPS_protmethod OnSharedDataChangeRequested(Object, WritableSharedDataItem, Byte[], AsyncStatus)

Handles a request from an extension for change in the value of a published data item.

System_CAPS_protmethod OnShow()

Called when a view is shown in the UI.

System_CAPS_protmethod OnShutdown(SyncStatus)

Called when a view needs be shut down.

System_CAPS_protmethod OnSyncAction(SyncAction, SyncStatus)

Handles the execution of a selection-independent (view-global) action that runs synchronous to MMC.

System_CAPS_protmethod OnSyncModeAction(SyncAction, SyncStatus)

Handles the execution of a view mode action that must run synchronously to MMC.

System_CAPS_protmethod OnSyncSelectionAction(SyncAction, SyncStatus)

Handles the execution of a selection-dependent action that runs synchronous to MMC.

System_CAPS_pubmethod SelectScopeNode(ScopeNode)

Selects the specified scope node in the MDI child window in which this view is visible. However, no action is performed if this view is hidden.

System_CAPS_pubmethod SelectScopeNode(ScopeNode, NodeId[])

Selects the specified scope node in the MDI child window in which the view is visible. However, no action is performed if this view is hidden.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

The four derived view classes that you can instantiate from are:

Notes to Implementers:

The ViewDescription and View are abstract classes that cannot be instantiated.

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