SingleDiagramDocView Class

Constructs a SingleDiagramDocView

May be set to provide an active in-place edit window Clipboard commands will be routed to this window.

A collection of all of the designers currently managed by the view

Gets or sets the content of this tool window.

Context menu that should be displayed when the design surface is right-clicked on

Gets the mouse position in absolute world coordinates when the context menu was invoked. This is valid when IsContextMenuShowing returns true.

The X position for the context menu

The Y position for the context menu

Current Designer

Current Diagram

String indicating the toolbox tab name that should be selected when this view gets focus.

Returns the toolbox items count in the default tool box tab.

Gets the document this view corresponds to.

Provides access to the IVsWindowFrame corresponding to this window. In most cases, direct access to this interface is not necessary

Overridden here to return false when the docview window is closed.

Help context managed by this window. Keywords and attributes placed in this context will have priority HelpContextType.Window.

Gets the initialization mode that is associated with this window pane.

Gets a value indicating whether the context menu is showing.

True if this is the primary view of the designer. The "primary view" owns the artifact document locks that are created by the VSHost during sync'ing. If an artifact is opened in an incompatible editor (e.g. the binary editor), the primary view is closed. This should shut down all other views.

Gets the IMenuCommandService which derived classes and hosted controls can use to add commands.

Returns the current primary selection. If one hasn't been set, returns the first object in the collection

Should we attempt to install ourselves as a ViewHelper?

Stores the elements currently selected in this window.

A count of the currently selected objects.

Help context managed by this window. Help keywords and attributes placed in this context have priority HelpContextType.Selection for document windows and HelpContextType.ToolWindowSelection for tool windows. The context is cleared on each selection change, so derived class that use this context should override OnSelectionChanged to keep it up-to-date.

Gets the service provider local to this window frame

Override to add in filter attributes on the current diagram.

Provides access to the toolbox service

Called by the ShellWindow during IVsWindowPane::CreatePaneWindow. Returns the single DesignSurface control hosted by this view

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.

Gives derived classes a chance to commit outstanding edits before a command is executed. This is called frequently, so only lightweight processing should be done here. This is preferable to IVsWindowPaneCommit.CommitPendingEdit, because it allows derived classes to make the decision to commit for some commands but not others.

ISelectionContainer.CountObjects (All).

Implementation of ISelectionContainer interface.

Implementation of ISelectionContainer interface.

Creates a new VSDiagramView with default settings.

Disposes the window pane and its resources.

Dispose of this instance

ISelectionContainer.SelectObjects.

Not implemented.

ISelectionContainer.GetObjects (Selected).

Specify which search option we support.

Returns true iff obj is currently selected.

Implementation identical to GetComponentSelected.

Get current cursor location

Retrieves the diagram corresponding to our physical view from the store.

Not implemented.

Implementation of ISelectionContainer interface.

Return the object that was requested. Our implementation only supports VSFTPROPID_DocName.

Not implemented.

Returns a read-only collection of currently selected components.

ISelectionContainer.GetObjects (Selected).

Override to return our menu command service implementation.

Implementation of IObjectWithSite.

Returns an array of ToolboxFilterItemAttributes for creating toolbox items that will be available when this doc view is active

Hides this window.

Overriden to publish context bag. For editors, general context should be associated with the SEID

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.

Test to see if the Browsable attribute is not set to false on the shape

Implementation of IVsToolboxUser interface. Determines if we support the referenced data object.

Implementation of IVsToolboxUser interface. Sends notification that an item in the toolbox is selected through a left-click, or by pressing Enter.

Override to load previously saved state of the pane

Called when the associated DocData is finished loading or reloading.
Derived classes should perform any initialization that requires the DocData to be loaded here.

Not implemented.

Not implemented.

Unused.

Called when window is closed. Overridden here to remove our objects from the selection context so that the property browser doesn't call back on our objects after the window is closed.

Processes context menu requested event from the client view. By default shows context menu returned from ContextMenuId property.

Overriden to recalculate toolbox item filters

Called prior to a selection change. Derived classes that override this method should make sure to call the base class so event listeners are notified.

Allows us to handle window messages.

Not implemented.

Override to save custom state information to be used later when the pane is reconstructed.

Implementation of ISelectionContainer interface.

Not implemented.

Override to set status bar info.

Not used. Implemenation of ISelectionService interface.

Pushes components into the selection container (replaces currently selected components), and notifies the shell of a selection change.

Implementation of IObjectWithSite.

Shows this window.

Shows context menu at specified point on the screen.

Shows this window without activating it.

Call to indicate that toolbox filter collections are invalid and need to be refreshed. Note that this does not actually refresh the toolbox. Clients may choose to do that based on the return value.

This event gets fired after a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.

This event gets fired just prior to a selection change in this window. Clients that want notification of selection changes to this window should register an event handler.

Called when a toolbox item is invoked (through double-click or pressing Enter key).

Called when toolbox selection changes (through single-click or pressing up/down arrow keys).

Executes the specified command.

Gets the status of the commands.

Gets the service of the specified type.

Called by the shell when it's time for us to set info on the status bar.

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.

Called when selection on toolbox changes (through a single-click or pressing up/down arrow keys).

Closes the pane.

Creates the pane.

When implemented in a derived class, gets the default size of the pane.

When implemented in a derived class, loads custom state storage.

Stores the state of the pane to the specified stream.

Sets the site for this window pane.

Handles keyboard accelerators before the shell processes the message.

Closes the window pane. Obsolete.

Creates a window pane. Obsolete.

Gets the default size of the window pane. Obsolete.

Loads the saved view state. Obsolete.

Saves the loaded view state. Obsolete.

Initializes this window pane with the specified service provider. Obsolete.

Handles the translation of navigation keys. Obsolete