ModelingDocView Class

Represents a document window in the Domain-Specific Language Designer or generated designer.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Shell.WindowPane
    Microsoft.VisualStudio.Modeling.Shell.ModelingWindowPane
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocView
        Microsoft.VisualStudio.Modeling.Shell.DiagramDocView

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public MustInherit Class ModelingDocView _
    Inherits ModelingWindowPane _
    Implements IVsStatusbarUser, IVsToolboxUser, IVsToolboxActiveUserHook

[CLSCompliantAttribute(false)]
public abstract class ModelingDocView : ModelingWindowPane, 
    IVsStatusbarUser, IVsToolboxUser, IVsToolboxActiveUserHook

[CLSCompliantAttribute(false)]
public ref class ModelingDocView abstract : public ModelingWindowPane, 
    IVsStatusbarUser, IVsToolboxUser, IVsToolboxActiveUserHook

[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type ModelingDocView =  
    class
        inherit ModelingWindowPane
        interface IVsStatusbarUser
        interface IVsToolboxUser
        interface IVsToolboxActiveUserHook
    end

public abstract class ModelingDocView extends ModelingWindowPane implements IVsStatusbarUser, IVsToolboxUser, IVsToolboxActiveUserHook

The ModelingDocView type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ActiveInPlaceEditWindow	Gets and sets the active window for in-place editing. (Inherited from ModelingWindowPane.)
	Content	(Inherited from WindowPane.)
	DefaultToolboxTabName	Gets the name of the Toolbox tab that the user clicked.
	DefaultToolboxTabToolboxItemsCount
	DocData	Gets a document for the document window.
	Frame	Gets the IVsWindowFrame that corresponds to this window.. (Inherited from ModelingWindowPane.)
	HasSelectableObjects	Gets the document window and if the document window is open, enables the Select Objects option. (Overrides ModelingWindowPane.HasSelectableObjects.)
	HelpService	Gets the help service. (Inherited from ModelingWindowPane.)
	InitializationMode	(Inherited from WindowPane.)
	IsPrimaryView	Gets the document window and verifies whether this window is the primary document window.
	MenuService	Gets the menu command service. (Inherited from ModelingWindowPane.)
	PrimarySelection	Gets the primary selected element in the window pane. (Inherited from ModelingWindowPane.)
	ProvideViewHelper	Gets the document window and verifies whether a view helper should be created for the document window.
	SelectedElements	Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)
	SelectionCount	Gets the number of elements that are selected in the window pane. (Inherited from ModelingWindowPane.)
	SelectionHelpService	Gets the selection help service. (Inherited from ModelingWindowPane.)
	ServiceProvider	Gets the service provider that is local to this window pane. (Inherited from ModelingWindowPane.)
	TargetToolboxItemFilterAttributes	Gets a collection of filter attributes for the document window.
	ToolboxService	Gets the Toolbox service.
	Window	(Inherited from WindowPane.)

Top

Methods

	Name	Description
	BaseLoadView	To be called when the associated DocData is finished loading or reloading, primarily from DocView.LoadView(). Performs any basic initialization required after loading a new DocData into the view.
	CommitPendingEditForCommand	When implemented in a derived class, specifies whether pending edits should be committed before a command is executed. (Inherited from ModelingWindowPane.)
	CountAllObjects	Gets the number of elements in the window pane. (Inherited from ModelingWindowPane.)
	CountObjects	Counts the number of elements in the window pane or in the current selection. (Inherited from ModelingWindowPane.)
	CountSelectedObjects	Gets the number of elements in the current selection. (Inherited from ModelingWindowPane.)
	Dispose()	(Inherited from WindowPane.)
	Dispose(Boolean)	Releases the unmanaged resources used by the ModelingDocView and optionally releases the managed resources. (Overrides ModelingWindowPane.Dispose(Boolean).)
	DoSelectObjects	When implemented in a derived class, selects elements in the window pane. (Inherited from ModelingWindowPane.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAllObjects	Gets all elements in the window pane. (Inherited from ModelingWindowPane.)
	GetComponentSelected	Specifies whether the given component is selected. (Inherited from ModelingWindowPane.)
	GetContainerSelected	Specifies whether the given container is selected. (Inherited from ModelingWindowPane.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetObjects	Gets either the elements that are currently selected or the elements that can be selected in the window pane. (Inherited from ModelingWindowPane.)
	GetSelectedComponents	Gets the components that are selected in the window pane. (Inherited from ModelingWindowPane.)
	GetSelectedObjects	Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)
	GetService	Gets the service of the specified type. Override this method to return the custom menu command service (Inherited from ModelingWindowPane.)
	GetSite	Gets the site that was set with SetSite. (Inherited from ModelingWindowPane.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Hide	Hides the window pane. (Inherited from ModelingWindowPane.)
	Initialize	Initializes an instance of the ModelingDocView class. (Overrides WindowPane.Initialize().)
	InterceptDataObject	Called by toolbox when the input data object is about to go into a drag-drop operation. This method allows the input data object to be substituted by the returned data object, which will go into the drag-drop operation instead. The base implementation returns null, which means no substitution of the input data object.
	IsDataObjectSupported	Verifies whether an item in the Toolbox can be used with the document window.
	IsSupported	Verifies whether the document window supports an item in the Toolbox.
	ItemPicked	Notifies clients that a user clicked an item in the Toolbox or pressed ENTER to select the item.
	LoadUIState	(Inherited from WindowPane.)
	LoadView	Verifies whether the document has loaded in a document window.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnClose	Removes window pane objects from the shortcut menu selection when the window pane is closed. (Inherited from ModelingWindowPane.)
	OnCreate	When the document is loaded, creates a view for the document window. (Overrides WindowPane.OnCreate().)
	OnSelectionChanged	Notifies event listeners after the selection changes. (Inherited from ModelingWindowPane.)
	OnSelectionChanging	Notifies event listeners before the selection changes. (Inherited from ModelingWindowPane.)
	OnToolboxItemSelected	When a user clicks an item in the Toolbox, calls ToolboxItemSelected.
	OnToolboxSelectionChanged
	PreProcessMessage	Handles window messages. (Inherited from ModelingWindowPane.)
	SaveUIState	(Inherited from WindowPane.)
	SelectObjects	Selects elements in the window pane. (Inherited from ModelingWindowPane.)
	SetInfo	Updates the status bar for the document window.
	SetSelectedComponents(ICollection)	Adds the specified components into the selection container and notifies the shell of the selection change. (Inherited from ModelingWindowPane.)
	SetSelectedComponents(ICollection, SelectionTypes)	Not currently implemented. (Inherited from ModelingWindowPane.)
	SetSite	Initializes the window pane in the environment. (Inherited from ModelingWindowPane.)
	Show	Displays the window pane, brings it to the front, and makes it the active window. (Inherited from ModelingWindowPane.)
	ShowNoActivate	Displays the window pane, brings it to the front, but does not make it the active window. (Inherited from ModelingWindowPane.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	SelectionChanged	Fired after the selection in the window pane has changed. (Inherited from ModelingWindowPane.)
	SelectionChanging	Fired before the selection in the window pane changes. (Inherited from ModelingWindowPane.)
	ToolboxItemSelected	Occurs when the user drags the selected item from the Toolbox to the document window.
	ToolboxSelectionChanged	Called when toolbox selection changes (through single-click or pressing up/down arrow keys).

Top

Explicit Interface Implementations

	Name	Description
	IVsToolboxActiveUserHook.InterceptDataObject	Called by toolbox when the input data object is about to go into a drag-drop operation. This method allows the input data object to be substituted by the output data object, which will go into the drag-drop operation instead.
	IVsStatusbarUser.SetInfo	Called by the shell when it's time for us to set info on the status bar.
	IVsToolboxActiveUserHook.ToolboxSelectionChanged	Called when selection on toolbox changes (through a single-click or pressing up/down arrow keys).
	IVsWindowPane.ClosePane	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.CloseUIElementPane	(Inherited from WindowPane.)
	IVsWindowPane.CreatePaneWindow	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.CreateUIElementPane	(Inherited from WindowPane.)
	IOleCommandTarget.Exec	(Inherited from WindowPane.)
	IVsWindowPane.GetDefaultSize	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.GetDefaultUIElementSize	(Inherited from WindowPane.)
	IServiceProvider.GetService	(Inherited from WindowPane.)
	IVsUIElementPane.LoadUIElementState	(Inherited from WindowPane.)
	IVsWindowPane.LoadViewState	Obsolete. (Inherited from WindowPane.)
	IOleCommandTarget.QueryStatus	(Inherited from WindowPane.)
	IVsUIElementPane.SaveUIElementState	(Inherited from WindowPane.)
	IVsWindowPane.SaveViewState	Obsolete. (Inherited from WindowPane.)
	IVsWindowPane.SetSite	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.SetUIElementSite	(Inherited from WindowPane.)
	IVsWindowPane.TranslateAccelerator	Obsolete. (Inherited from WindowPane.)
	IVsUIElementPane.TranslateUIElementAccelerator	(Inherited from WindowPane.)

Top

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