DiagramDocView Class
Represents a diagram view 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
Microsoft.VisualStudio.Modeling.Shell.SingleDiagramDocView
Namespace: Microsoft.VisualStudio.Modeling.Shell
Assembly: Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.10.0.dll)
Syntax
'Declaração
<CLSCompliantAttribute(False)> _
Public MustInherit Class DiagramDocView _
Inherits ModelingDocView _
Implements IVsFindTarget, IContextMenuHost
[CLSCompliantAttribute(false)]
public abstract class DiagramDocView : ModelingDocView,
IVsFindTarget, IContextMenuHost
[CLSCompliantAttribute(false)]
public ref class DiagramDocView abstract : public ModelingDocView,
IVsFindTarget, IContextMenuHost
[<AbstractClass>]
[<CLSCompliantAttribute(false)>]
type DiagramDocView =
class
inherit ModelingDocView
interface IVsFindTarget
interface IContextMenuHost
end
public abstract class DiagramDocView extends ModelingDocView implements IVsFindTarget, IContextMenuHost
The DiagramDocView type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DiagramDocView | Initializes a new instance of the DiagramDocView class. |
Top
Properties
Name | Description | |
---|---|---|
ActiveInPlaceEditWindow | Gets and sets the active window for in-place editing. (Inherited from ModelingWindowPane.) | |
Content | (Inherited from WindowPane.) | |
ContextMenuId | Gets the shortcut menu to display when a user right-clicks the diagram view. | |
ContextMenuMousePosition | Gets the position of the mouse when the shortcut menu is invoked for the diagram view. | |
ContextMenuXPosition | The X position for the context menu | |
ContextMenuYPosition | The Y position for the context menu | |
CurrentDesigner | Gets the active diagram view. | |
CurrentDiagram | Gets the currently selected model in the active diagram view. | |
DefaultToolboxTabName | Gets the name of the Toolbox tab that the user clicked. (Inherited from ModelingDocView.) | |
DefaultToolboxTabToolboxItemsCount | (Inherited from ModelingDocView.) | |
DocData | Gets a document for the document window. (Inherited from ModelingDocView.) | |
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. (Inherited from ModelingDocView.) | |
HelpService | Gets the help service. (Inherited from ModelingWindowPane.) | |
InitializationMode | (Inherited from WindowPane.) | |
IsContextMenuShowing | Gets the shortcut menu and verifies whether it appears for the diagram view. | |
IsPrimaryView | Gets the document window and verifies whether this window is the primary document window. (Inherited from ModelingDocView.) | |
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. (Inherited from ModelingDocView.) | |
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 a Toolbox item. (Overrides ModelingDocView.TargetToolboxItemFilterAttributes.) | |
ToolboxService | Gets the Toolbox service. (Inherited from ModelingDocView.) | |
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. (Inherited from ModelingDocView.) | |
CommitPendingEditForCommand | Verifies whether outstanding edits should be committed before a command is executed. (Overrides ModelingWindowPane.CommitPendingEditForCommand(CommandID).) | |
CountAllObjects | Counts the number of elements that are in the model. (Overrides ModelingWindowPane.CountAllObjects().) | |
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.) | |
CreateDiagramView | Creates a diagram view for the document window. | |
Dispose() | (Inherited from WindowPane.) | |
Dispose(Boolean) | Releases the unmanaged resources used by the DiagramDocView and optionally releases the managed resources. (Overrides ModelingDocView.Dispose(Boolean).) | |
DoSelectObjects | Selects elements in the diagram view. (Overrides ModelingWindowPane.DoSelectObjects(UInt32, array<Object[], UInt32).) | |
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.) | |
Find | Not currently implemented. | |
GetAllObjects | Gets all elements in the model. (Overrides ModelingWindowPane.GetAllObjects(UInt32, array<Object[]).) | |
GetCapabilities | Specifies which search options to support. | |
GetComponentSelected | Specifies whether the given component is selected. (Inherited from ModelingWindowPane.) | |
GetContainerSelected | Specifies whether the given container is selected. (Inherited from ModelingWindowPane.) | |
GetCurrentSpan | Not currently implemented. | |
GetDiagramFromPhysicalView | Gets a model from the Store so that it can appear in the diagram view. | |
GetFindState | Not currently implemented. | |
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.) | |
GetProperty | Gets the properties that are assigned to an element in the model. | |
GetSearchImage | Not currently implemented. | |
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.) | |
GetToolboxItemFilterAttributes | Gets a collection of filter strings and filter types for the Toolbox. | |
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. (Inherited from ModelingDocView.) | |
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. (Inherited from ModelingDocView.) | |
IsDataObjectSupported | Verifies whether an item in the Toolbox can be used with the document window. (Inherited from ModelingDocView.) | |
IsObjectBrowsable | Returns true if the Browsable attribute of the element is true. | |
IsSupported | Verifies whether the document window supports an item in the Toolbox. (Inherited from ModelingDocView.) | |
ItemPicked | Notifies clients that a user clicked an item in the Toolbox or pressed ENTER to select the item. (Inherited from ModelingDocView.) | |
LoadUIState | (Inherited from WindowPane.) | |
LoadView | Verifies whether the document has loaded in a document window. (Inherited from ModelingDocView.) | |
MarkSpan | Not currently implemented. | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NavigateTo | Not currently implemented. | |
NotifyFindTarget | This member is no longer used. | |
OnClose | Removes window pane objects from the shortcut menu selection when the window pane is closed. (Inherited from ModelingWindowPane.) | |
OnContextMenuRequested | Processes a request for the shortcut menu. | |
OnCreate | When the document is loaded, creates a view for the document window. (Inherited from ModelingDocView.) | |
OnSelectionChanged | Recalculates which Toolbox filters to use. (Overrides ModelingWindowPane.OnSelectionChanged(EventArgs).) | |
OnSelectionChanging | Notifies event listeners before the selection changes. (Inherited from ModelingWindowPane.) | |
OnToolboxItemSelected | When a user clicks an item in the Toolbox, calls ToolboxItemSelected. (Inherited from ModelingDocView.) | |
OnToolboxSelectionChanged | (Inherited from ModelingDocView.) | |
PreProcessMessage | Handles window messages. (Inherited from ModelingWindowPane.) | |
Replace | Not currently implemented. | |
SaveUIState | (Inherited from WindowPane.) | |
SelectObjects | Selects elements in the window pane. (Inherited from ModelingWindowPane.) | |
SetFindState | Not currently implemented. | |
SetInfo | Updates the status bar for the document window. (Inherited from ModelingDocView.) | |
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.) | |
ShowContextMenu | Displays the shortcut menu at a specific location in the diagram view. | |
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.) | |
UpdateToolboxFilters | Updates the collection of Toolbox filters to use with the active diagram view. |
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. (Inherited from ModelingDocView.) | |
ToolboxSelectionChanged | Called when toolbox selection changes (through single-click or pressing up/down arrow keys). (Inherited from ModelingDocView.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IVsFindTarget.GetMatchRect | ||
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. (Inherited from ModelingDocView.) | |
IVsStatusbarUser.SetInfo | Called by the shell when it's time for us to set info on the status bar. (Inherited from ModelingDocView.) | |
IVsToolboxActiveUserHook.ToolboxSelectionChanged | Called when selection on toolbox changes (through a single-click or pressing up/down arrow keys). (Inherited from ModelingDocView.) | |
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
Remarks
You use the diagram view to display models. A model is a collection of elements.
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.