SingleDiagramDocView Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Important
This API is not CLS-compliant.
Class that hosts a single diagram within a view
public ref class SingleDiagramDocView abstract : Microsoft::VisualStudio::Modeling::Shell::DiagramDocView[System.CLSCompliant(false)]
public abstract class SingleDiagramDocView : Microsoft.VisualStudio.Modeling.Shell.DiagramDocViewpublic abstract class SingleDiagramDocView : Microsoft.VisualStudio.Modeling.Shell.DiagramDocView[<System.CLSCompliant(false)>]
type SingleDiagramDocView = class
inherit DiagramDocViewtype SingleDiagramDocView = class
inherit DiagramDocViewPublic MustInherit Class SingleDiagramDocView
Inherits DiagramDocView- Inheritance
- Attributes
Constructors
| SingleDiagramDocView(ModelingDocData, IServiceProvider) |
Constructs a SingleDiagramDocView |
Properties
| ActiveInPlaceEditWindow |
May be set to provide an active in-place edit window Clipboard commands will be routed to this window. (Inherited from ModelingWindowPane) |
| AllDesigners |
A collection of all of the designers currently managed by the view |
| Content |
Gets or sets the content of this tool window. (Inherited from WindowPane) |
| ContextMenuId |
Context menu that should be displayed when the design surface is right-clicked on (Inherited from DiagramDocView) |
| ContextMenuMousePosition |
Gets the mouse position in absolute world coordinates when the context menu was invoked. This is valid when IsContextMenuShowing returns true. (Inherited from DiagramDocView) |
| ContextMenuXPosition |
The X position for the context menu (Inherited from DiagramDocView) |
| ContextMenuYPosition |
The Y position for the context menu (Inherited from DiagramDocView) |
| CurrentDesigner |
Current Designer |
| CurrentDiagram |
Current Diagram |
| DefaultToolboxTabName |
String indicating the toolbox tab name that should be selected when this view gets focus. (Inherited from ModelingDocView) |
| DefaultToolboxTabToolboxItemsCount |
Returns the toolbox items count in the default tool box tab. (Inherited from ModelingDocView) |
| Diagram | |
| DocData |
Gets the document this view corresponds to. (Inherited from ModelingDocView) |
| Frame |
Provides access to the IVsWindowFrame corresponding to this window. In most cases, direct access to this interface is not necessary (Inherited from ModelingWindowPane) |
| HasSelectableObjects |
Overridden here to return false when the docview window is closed. (Inherited from ModelingDocView) |
| HelpService |
Help context managed by this window. Keywords and attributes placed in this context will have priority HelpContextType.Window. (Inherited from ModelingWindowPane) |
| InitializationMode |
Gets the initialization mode that is associated with this window pane. (Inherited from WindowPane) |
| IsContextMenuShowing |
Gets a value indicating whether the context menu is showing. (Inherited from DiagramDocView) |
| IsPrimaryView |
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. (Inherited from ModelingDocView) |
| MenuService |
Gets the IMenuCommandService which derived classes and hosted controls can use to add commands. (Inherited from ModelingWindowPane) |
| ParentHandle | (Inherited from WindowPane) |
| PrimarySelection |
Returns the current primary selection. If one hasn't been set, returns the first object in the collection (Inherited from ModelingWindowPane) |
| ProvideViewHelper |
Should we attempt to install ourselves as a ViewHelper? (Inherited from ModelingDocView) |
| SelectedElements |
Stores the elements currently selected in this window. (Inherited from ModelingWindowPane) |
| SelectionCount |
A count of the currently selected objects. (Inherited from ModelingWindowPane) |
| SelectionHelpService |
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. (Inherited from ModelingWindowPane) |
| ServiceProvider |
Gets the service provider local to this window frame (Inherited from ModelingWindowPane) |
| TargetToolboxItemFilterAttributes |
Override to add in filter attributes on the current diagram. (Inherited from DiagramDocView) |
| ToolboxService |
Provides access to the toolbox service (Inherited from ModelingDocView) |
| Window |
Called by the ShellWindow during IVsWindowPane::CreatePaneWindow. Returns the single DesignSurface control hosted by this view |
Methods
| 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(CommandID) |
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. (Inherited from DiagramDocView) |
| CountAllObjects() |
ISelectionContainer.CountObjects (All). (Inherited from DiagramDocView) |
| CountObjects(UInt32, UInt32) |
Implementation of ISelectionContainer interface. (Inherited from ModelingWindowPane) |
| CountSelectedObjects() |
Implementation of ISelectionContainer interface. (Inherited from ModelingWindowPane) |
| CreateDiagramView() |
Creates a new VSDiagramView with default settings. (Inherited from DiagramDocView) |
| Dispose() |
Disposes the window pane and its resources. (Inherited from WindowPane) |
| Dispose(Boolean) |
Dispose of this instance |
| DoSelectObjects(UInt32, Object[], UInt32) |
ISelectionContainer.SelectObjects. (Inherited from DiagramDocView) |
| Find(String, UInt32, Int32, IVsFindHelper, UInt32) |
Not implemented. (Inherited from DiagramDocView) |
| GetAllObjects(UInt32, Object[]) |
ISelectionContainer.GetObjects (Selected). (Inherited from DiagramDocView) |
| GetCapabilities(Boolean[], UInt32[]) |
Specify which search option we support. (Inherited from DiagramDocView) |
| GetComponentSelected(Object) |
Returns true iff obj is currently selected. (Inherited from ModelingWindowPane) |
| GetContainerSelected(Object) |
Implementation identical to GetComponentSelected. (Inherited from ModelingWindowPane) |
| GetCurrentSpan(TextSpan[]) |
Get current cursor location (Inherited from DiagramDocView) |
| GetDiagramFromPhysicalView(Guid) |
Retrieves the diagram corresponding to our physical view from the store. (Inherited from DiagramDocView) |
| GetFindState(Object) |
Not implemented. (Inherited from DiagramDocView) |
| GetObjects(UInt32, UInt32, Object[]) |
Implementation of ISelectionContainer interface. (Inherited from ModelingWindowPane) |
| GetProperty(UInt32, Object) |
Return the object that was requested. Our implementation only supports VSFTPROPID_DocName. (Inherited from DiagramDocView) |
| GetSearchImage(UInt32, IVsTextSpanSet[], IVsTextImage) |
Not implemented. (Inherited from DiagramDocView) |
| GetSelectedComponents() |
Returns a read-only collection of currently selected components. (Inherited from ModelingWindowPane) |
| GetSelectedObjects(UInt32, Object[]) |
ISelectionContainer.GetObjects (Selected). (Inherited from ModelingWindowPane) |
| GetService(Type) |
Override to return our menu command service implementation. (Inherited from ModelingWindowPane) |
| GetSite(Guid, IntPtr) |
Implementation of IObjectWithSite. (Inherited from ModelingWindowPane) |
| GetToolboxItemFilterAttributes() |
Returns an array of ToolboxFilterItemAttributes for creating toolbox items that will be available when this doc view is active (Inherited from DiagramDocView) |
| Hide() |
Hides this window. (Inherited from ModelingWindowPane) |
| Initialize() |
Overriden to publish context bag. For editors, general context should be associated with the SEID (Inherited from ModelingDocView) |
| InterceptDataObject(IDataObject) |
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(IDataObject) | (Inherited from ModelingDocView) |
| IsObjectBrowsable(ModelElement) |
Test to see if the Browsable attribute is not set to false on the shape (Inherited from DiagramDocView) |
| IsSupported(IDataObject) |
Implementation of IVsToolboxUser interface. Determines if we support the referenced data object. (Inherited from ModelingDocView) |
| ItemPicked(IDataObject) |
Implementation of IVsToolboxUser interface. Sends notification that an item in the toolbox is selected through a left-click, or by pressing Enter. (Inherited from ModelingDocView) |
| LoadUIState(Stream) |
Override to load previously saved state of the pane (Inherited from WindowPane) |
| LoadView() |
Called when the associated DocData is finished loading or reloading. |
| MarkSpan(TextSpan[]) |
Not implemented. (Inherited from DiagramDocView) |
| NavigateTo(TextSpan[]) |
Not implemented. (Inherited from DiagramDocView) |
| NotifyFindTarget(UInt32) |
Unused. (Inherited from DiagramDocView) |
| OnClose() |
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. (Inherited from ModelingWindowPane) |
| OnContextMenuRequested(DiagramPointEventArgs) |
Processes context menu requested event from the client view. By default shows context menu returned from ContextMenuId property. (Inherited from DiagramDocView) |
| OnCreate() | (Inherited from ModelingDocView) |
| OnSelectionChanged(EventArgs) |
Overriden to recalculate toolbox item filters (Inherited from DiagramDocView) |
| OnSelectionChanging(EventArgs) |
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. (Inherited from ModelingWindowPane) |
| OnToolboxItemSelected(IDataObject) | (Inherited from ModelingDocView) |
| OnToolboxSelectionChanged() | (Inherited from ModelingDocView) |
| PreProcessMessage(Message) |
Allows us to handle window messages. (Inherited from ModelingWindowPane) |
| Replace(String, String, UInt32, Int32, IVsFindHelper, Int32) |
Not implemented. (Inherited from DiagramDocView) |
| SaveUIState(Stream) |
Override to save custom state information to be used later when the pane is reconstructed. (Inherited from WindowPane) |
| SelectObjects(UInt32, Object[], UInt32) |
Implementation of ISelectionContainer interface. (Inherited from ModelingWindowPane) |
| SetFindState(Object) |
Not implemented. (Inherited from DiagramDocView) |
| SetInfo() |
Override to set status bar info. (Inherited from ModelingDocView) |
| SetSelectedComponents(ICollection, SelectionTypes) |
Not used. Implemenation of ISelectionService interface. (Inherited from ModelingWindowPane) |
| SetSelectedComponents(ICollection) |
Pushes components into the selection container (replaces currently selected components), and notifies the shell of a selection change. (Inherited from ModelingWindowPane) |
| SetSite(Object) |
Implementation of IObjectWithSite. (Inherited from ModelingWindowPane) |
| Show() |
Shows this window. (Inherited from ModelingWindowPane) |
| ShowContextMenu(CommandID, Point) |
Shows context menu at specified point on the screen. (Inherited from DiagramDocView) |
| ShowNoActivate() |
Shows this window without activating it. (Inherited from ModelingWindowPane) |
| UpdateToolboxFilters(DiagramDocView+ToolboxItemFilterType, Boolean) |
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. (Inherited from DiagramDocView) |
Events
| SelectionChanged |
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. (Inherited from ModelingWindowPane) |
| SelectionChanging |
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. (Inherited from ModelingWindowPane) |
| ToolboxItemSelected |
Called when a toolbox item is invoked (through double-click or pressing Enter key). (Inherited from ModelingDocView) |
| ToolboxSelectionChanged |
Called when toolbox selection changes (through single-click or pressing up/down arrow keys). (Inherited from ModelingDocView) |
Explicit Interface Implementations
| IOleCommandTarget.Exec(Guid, UInt32, UInt32, IntPtr, IntPtr) |
Executes the specified command. (Inherited from WindowPane) |
| IOleCommandTarget.QueryStatus(Guid, UInt32, OLECMD[], IntPtr) |
Gets the status of the commands. (Inherited from WindowPane) |
| IServiceProvider.GetService(Type) |
Gets the service of the specified type. (Inherited from WindowPane) |
| IVsFindTarget.GetMatchRect(RECT[]) | (Inherited from DiagramDocView) |
| IVsStatusbarUser.SetInfo() |
Called by the shell when it's time for us to set info on the status bar. (Inherited from ModelingDocView) |
| IVsToolboxActiveUserHook.InterceptDataObject(IDataObject, IDataObject) |
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) |
| IVsToolboxActiveUserHook.ToolboxSelectionChanged(IDataObject) |
Called when selection on toolbox changes (through a single-click or pressing up/down arrow keys). (Inherited from ModelingDocView) |
| IVsUIElementPane.CloseUIElementPane() |
Closes the pane. (Inherited from WindowPane) |
| IVsUIElementPane.CreateUIElementPane(Object) |
Creates the pane. (Inherited from WindowPane) |
| IVsUIElementPane.GetDefaultUIElementSize(SIZE[]) |
When implemented in a derived class, gets the default size of the pane. (Inherited from WindowPane) |
| IVsUIElementPane.LoadUIElementState(IStream) |
When implemented in a derived class, loads custom state storage. (Inherited from WindowPane) |
| IVsUIElementPane.SaveUIElementState(IStream) |
Stores the state of the pane to the specified stream. (Inherited from WindowPane) |
| IVsUIElementPane.SetUIElementSite(IServiceProvider) |
Sets the site for this window pane. (Inherited from WindowPane) |
| IVsUIElementPane.TranslateUIElementAccelerator(MSG[]) |
Handles keyboard accelerators before the shell processes the message. (Inherited from WindowPane) |
| IVsWindowPane.ClosePane() |
Obsolete.
Closes the window pane. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.CreatePaneWindow(IntPtr, Int32, Int32, Int32, Int32, IntPtr) |
Obsolete.
Creates a window pane. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.GetDefaultSize(SIZE[]) |
Obsolete.
Gets the default size of the window pane. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.LoadViewState(IStream) |
Obsolete.
Loads the saved view state. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.SaveViewState(IStream) |
Obsolete.
Saves the loaded view state. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.SetSite(IServiceProvider) |
Obsolete.
Initializes this window pane with the specified service provider. Obsolete. (Inherited from WindowPane) |
| IVsWindowPane.TranslateAccelerator(MSG[]) |
Obsolete.
Handles the translation of navigation keys. Obsolete (Inherited from WindowPane) |