View Class

Article
01/20/2017

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
	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.
	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.
	IsModified	Gets or sets a flag that indicates that the view has data that needs to be saved.
	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.
	ScopeNode	Gets the scope node with which this view is associated.
	SelectionData	Gets the selection data for the view.
	SharedTag	Gets or sets an object that is shared across view instances of a particular MDI child.
	SnapIn	Gets the snap-in associated with the view.
	ViewDescriptionTag	Gets the tag that was set on the associated view description.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	ExpandScopeNode(ScopeNode)	Expands the specified scope node.
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	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.
	MemberwiseClone()	(Inherited from Object.)
	OnAction(Action, AsyncStatus)	Handles the execution of a selection-independent action.
	OnAddPropertyPages(PropertyPageCollection)	Called to add property pages to a property sheet.
	OnCut(Object, AsyncStatus)	Called so that the snap-in can cut items from the given selection after it has been pasted elsewhere.
	OnDelete(SyncStatus)	Called when the Delete standard verb is triggered.
	OnGetSharedData(Object, WritableSharedDataItem, SyncStatus)	Handles a request to provide data for a published data item that was designated as one that requires a callback.
	OnHide()	Called when a view is hidden in the UI.
	OnInitialize(AsyncStatus)	Allows snap-in code to perform custom view initialization.
	OnLoadCustomData(AsyncStatus, Byte[])	Allows the snap-in to receive previously stored binary data that is contained in the console file.
	OnModeAction(Action, AsyncStatus)	Handles the execution of an action that is used to configure view modes.
	OnPaste(SharedData, DragAndDropVerb, SyncStatus)	Invoked when data is pasted onto the current selection.
	OnPrint(SyncStatus)	Called when the Print standard verb is triggered.
	OnRefresh(AsyncStatus)	Called when the Refresh standard verb is triggered.
	OnRename(String, SyncStatus)	Called when the Rename standard verb is triggered.
	OnSaveCustomData(SyncStatus)	Allows the view to store binary data in the console file.
	OnSelectionAction(Action, AsyncStatus)	Handles the execution of a selection-dependent action.
	OnSharedDataChangeRequested(Object, WritableSharedDataItem, Byte[], AsyncStatus)	Handles a request from an extension for change in the value of a published data item.
	OnShow()	Called when a view is shown in the UI.
	OnShutdown(SyncStatus)	Called when a view needs be shut down.
	OnSyncAction(SyncAction, SyncStatus)	Handles the execution of a selection-independent (view-global) action that runs synchronous to MMC.
	OnSyncModeAction(SyncAction, SyncStatus)	Handles the execution of a view mode action that must run synchronously to MMC.
	OnSyncSelectionAction(SyncAction, SyncStatus)	Handles the execution of a selection-dependent action that runs synchronous to MMC.
	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.
	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.
	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.

Share via