Share via


DiagramDocView Members

Include Protected Members
Include Inherited Members

Represents a diagram view in the Domain-Specific Language Designer or generated designer.

The DiagramDocView type exposes the following members.

Constructors

 

Name

Description

Protected method

DiagramDocView

Initializes a new instance of the DiagramDocView class.

Top

Methods

 

Name

Description

Protected method

BaseLoadView

(Inherited from ModelingDocView.)

Protected method

CommitPendingEditForCommand

Verifies whether outstanding edits should be committed before a command is executed. (Overrides ModelingWindowPane.CommitPendingEditForCommand(CommandID).)

Protected method

CountAllObjects

Counts the number of elements that are in the model. (Overrides ModelingWindowPane.CountAllObjects().)

Public method

CountObjects

Counts the number of elements in the window pane or in the current selection. (Inherited from ModelingWindowPane.)

Protected method

CountSelectedObjects

Gets the number of elements in the current selection. (Inherited from ModelingWindowPane.)

Public method

CreateDiagramView

Creates a diagram view for the document window.

Public method

Dispose

Overloaded.

Protected method

DoSelectObjects

Selects elements in the diagram view. (Overrides ModelingWindowPane.DoSelectObjects(UInt32, array<Object[], UInt32).)

Public method

Equals

Determines whether the specified Object is equal to the current Object. (Inherited from Object.)

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)

Public method

Find

Not currently implemented.

Protected method

GetAllObjects

Gets all elements in the model. (Overrides ModelingWindowPane.GetAllObjects(UInt32, array<Object[]).)

Public method

GetCapabilities

Specifies which search options to support.

Public method

GetComponentSelected

Specifies whether the given component is selected. (Inherited from ModelingWindowPane.)

Public method

GetContainerSelected

Specifies whether the given container is selected. (Inherited from ModelingWindowPane.)

Public method

GetCurrentSpan

Not currently implemented.

Protected method

GetDiagramFromPhysicalView

Gets a model from the Store so that it can appear in the diagram view.

Public method

GetFindState

Not currently implemented.

Public method

GetHashCode

Serves as a hash function for a particular type. (Inherited from Object.)

Public method

GetObjects

Gets either the elements that are currently selected or the elements that can be selected in the window pane. (Inherited from ModelingWindowPane.)

Public method

GetProperty

Gets the properties that are assigned to an element in the model.

Public method

GetSearchImage

Not currently implemented.

Public method

GetSelectedComponents

Gets the components that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected method

GetSelectedObjects

Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected method

GetService

Gets the service of the specified type. Override this method to return the custom menu command service (Inherited from ModelingWindowPane.)

Public method

GetSite

Gets the site that was set with SetSite. (Inherited from ModelingWindowPane.)

Public method

GetToolboxItemFilterAttributes

Gets a collection of filter strings and filter types for the Toolbox.

Public method

GetType

Gets the type of the current instance. (Inherited from Object.)

Public method

Hide

Hides the window pane. (Inherited from ModelingWindowPane.)

Protected method

Initialize

Initializes an instance of the ModelingDocView class. (Inherited from ModelingDocView.)

Public method

IsDataObjectSupported

Verifies whether an item in the Toolbox can be used with the document window. (Inherited from ModelingDocView.)

Public method

IsSupported

Verifies whether the document window supports an item in the Toolbox. (Inherited from ModelingDocView.)

Public method

ItemPicked

Notifies clients that a user clicked an item in the Toolbox or pressed ENTER to select the item. (Inherited from ModelingDocView.)

Protected method

LoadView

Verifies whether the document has loaded in a document window. (Inherited from ModelingDocView.)

Public method

MarkSpan

Not currently implemented.

Protected method

MemberwiseClone

Creates a shallow copy of the current Object. (Inherited from Object.)

Public method

NavigateTo

Not currently implemented.

Public method

NotifyFindTarget

This member is no longer used.

Protected method

OnClose

Removes window pane objects from the shortcut menu selection when the window pane is closed. (Inherited from ModelingWindowPane.)

Protected method

OnContextMenuRequested

Processes a request for the shortcut menu.

Protected method

OnCreate

When the document is loaded, creates a view for the document window. (Inherited from ModelingDocView.)

Protected method

OnSelectionChanged

Recalculates which Toolbox filters to use. (Overrides ModelingWindowPane.OnSelectionChanged(EventArgs).)

Protected method

OnSelectionChanging

Notifies event listeners before the selection changes. (Inherited from ModelingWindowPane.)

Protected method

OnToolboxItemSelected

When a user clicks an item in the Toolbox, calls ToolboxItemSelected. (Inherited from ModelingDocView.)

Protected method

PreProcessMessage

Handles window messages. (Inherited from ModelingWindowPane.)

Public method

Replace

Not currently implemented.

Public method

SelectObjects

Selects elements in the window pane. (Inherited from ModelingWindowPane.)

Public method

SetFindState

Not currently implemented.

Public method

SetInfo

Updates the status bar for the document window. (Inherited from ModelingDocView.)

Public method

SetSelectedComponents

Overloaded. Puts the selected components into the selection container and replaces the currently-selected components, and notifies the shell of the change.

Public method

SetSite

Initializes the window pane in the environment. (Inherited from ModelingWindowPane.)

Public method

Show

Displays the window pane, brings it to the front, and makes it the active window. (Inherited from ModelingWindowPane.)

Protected method

ShowContextMenu

Displays the shortcut menu at a specific location in the diagram view.

Public method

ShowNoActivate

Displays the window pane, brings it to the front, but does not make it the active window. (Inherited from ModelingWindowPane.)

Public method

ToString

Returns a string that represents the current object. (Inherited from Object.)

Protected method

UpdateToolboxFilters

Updates the collection of Toolbox filters to use with the active diagram view.

Top

Properties

 

Name

Description

Public property

ActiveInPlaceEditWindow

Gets and sets the active window for in-place editing. (Inherited from ModelingWindowPane.)

Protected property

ContextMenuId

Gets the shortcut menu to display when a user right-clicks the diagram view.

Public property

ContextMenuMousePosition

Gets the position of the mouse when the shortcut menu is invoked for the diagram view.

Public property

CurrentDesigner

Gets the active diagram view.

Public property

CurrentDiagram

Gets the currently selected model in the active diagram view.

Protected property

DefaultToolboxTabName

Gets the name of the Toolbox tab that the user clicked. (Inherited from ModelingDocView.)

Protected property

DefaultToolboxTabToolboxItemsCount

(Inherited from ModelingDocView.)

Public property

DocData

Gets a document for the document window. (Inherited from ModelingDocView.)

Public property

Frame

Gets the IVsWindowFrame that corresponds to this window.. (Inherited from ModelingWindowPane.)

Protected property

HasSelectableObjects

Gets the document window and if the document window is open, enables the Select Objects option. (Inherited from ModelingDocView.)

Protected property

HelpService

Gets the help service. (Inherited from ModelingWindowPane.)

Public property

IsContextMenuShowing

Gets the shortcut menu and verifies whether it appears for the diagram view.

Protected property

IsPrimaryView

Gets the document window and verifies whether this window is the primary document window. (Inherited from ModelingDocView.)

Public property

MenuService

Gets the menu command service. (Inherited from ModelingWindowPane.)

Public property

PrimarySelection

Gets the primary selected element in the window pane. (Inherited from ModelingWindowPane.)

Protected property

ProvideViewHelper

Gets the document window and verifies whether a view helper should be created for the document window. (Inherited from ModelingDocView.)

Protected property

SelectedElements

Gets the elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Public property

SelectionCount

Gets the number of elements that are selected in the window pane. (Inherited from ModelingWindowPane.)

Protected property

SelectionHelpService

Gets the selection help service. (Inherited from ModelingWindowPane.)

Protected property

ServiceProvider

Gets the service provider that is local to this window pane. (Inherited from ModelingWindowPane.)

Protected property

TargetToolboxItemFilterAttributes

Gets a collection of filter attributes for a Toolbox item. (Overrides ModelingDocView.TargetToolboxItemFilterAttributes.)

Protected property

ToolboxService

Gets the Toolbox service. (Inherited from ModelingDocView.)

Public property

Window

(Inherited from WindowPane.)

Top

Events

 

Name

Description

Public event

SelectionChanged

Fired after the selection in the window pane has changed. (Inherited from ModelingWindowPane.)

Public event

SelectionChanging

Fired before the selection in the window pane changes. (Inherited from ModelingWindowPane.)

Public event

ToolboxItemSelected

Occurs when the user drags the selected item from the Toolbox to the document window. (Inherited from ModelingDocView.)

Top

Explicit Interface Implementations

 

Name

Description

Explicit interface implemetationPrivate method

IVsWindowPane.ClosePane

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.CreatePaneWindow

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.Exec

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.GetDefaultSize

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsFindTarget.GetMatchRect

Explicit interface implemetationPrivate method

IServiceProvider.GetService

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.LoadViewState

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsBroadcastMessageEvents.OnBroadcastMessage

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IOleCommandTarget.QueryStatus

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.SaveViewState

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsStatusbarUser.SetInfo

(Inherited from ModelingDocView.)

Explicit interface implemetationPrivate method

IVsWindowPane.SetSite

(Inherited from WindowPane.)

Explicit interface implemetationPrivate method

IVsWindowPane.TranslateAccelerator

(Inherited from WindowPane.)

Top

See Also

Reference

DiagramDocView Class

Microsoft.VisualStudio.Modeling.Shell Namespace