Microsoft.VisualStudio.Modeling.Shell Namespace
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.
Classes
AmbientFontService |
This class is providing service by returning ambient font setttings based on VS |
AsyncModelingPackage |
Toolbox related bits |
ClassViewImages |
Provides access to the image list used by the VS Class View, Object Browser, and intellisense |
ClassViewNavigationInfo |
Helper class for decoding navigation info data objects |
ClipboardCommandSet |
ClipboardCommandSet to support cut/copy/paste operation. |
CommandContextBoundMenuCommand |
Represents a menu command bound to a particular UI context. This command will only be visible if the given command UI context is active. These commands should be used in conjunction with entries in the VISIBILITY_SECTION of the CTC file. |
CommandContextChangedEventArgs |
EventArgs catpturing information about a command context change event. |
CommandSet |
Commands supported by this designer |
CommandSetLibrary |
Base class for command classes interacts with visual studio commands. Contains DocData, DocView and selection related properties. |
CommonModelingCommands |
Defines CommandID objects for shared commands. |
ContainerBase |
This is the base class for the main control in tool windows. It performs such things as drawing a border, a watermark, and any other common tool window operations. |
CurrentSelectionPusher |
Class to expose the current selection from a set of WinForms Currency Manager Providers or WPF Content Controls to the Visual Studio properties window |
DiagramDocView |
DocView designed to contain one or more Diagram PresentationElement. |
DiagramExporter |
An exporter capable of finding diagram files in a solution, and exporting them to disk as images. |
DialogBase |
Base class for dialogs that will be hosted in the VS shell. |
DocData |
Abstract base class representing a file in memory. This class implements the IVsPersistDocData2 interface, which the shell calls through to load and save the document. This class also handled listening to external file change events, and prompting the user to reload the file. |
DocumentSavedEventArgs |
EventArgs class to carry data about a file save operation |
DslModelExplorerFilter |
DslModelExplorerFilter is the filer which decides what relationship we should not visit |
DynamicStatusMenuCommand |
Alias for the VsMenuCommand. It is intendend to reduce the merge conflicts during Lab22dev to Lab23 integrations and must be deleted in Lab23 when the integration is done. |
ElementTreeNode |
Abstract class of ExplorerTreeNodes that represent ModelElements |
ErrorListObserver |
ErrorListObserver monitors changes after VsValidationController finishes the validation. It reports the error/warning/message in the VS ErrorList and Output window. |
ExplorerElementVisitor |
Summary Description for ExplorerElementVisitor. |
ExplorerTreeNode |
Our own TreeNode implementation for displaying properties and relationships |
ExportErrorEventArgs |
Arguments related to an ExportErrorEvent. |
FileCancelException |
FileCancelException. |
LinkedTransaction |
Class that handles opening and closing of a VS Globally linked transaction through the IVsLinkedUndoTransactionManager class. Also manages an IMS transaction within this linked transaction |
ModelElementLocator |
Helper class for working with model element references. |
ModelElementTreeNode |
TreeNode implementation for displaying a ModelElement |
ModelExplorerToolWindow |
This is the tool window class that houses the Model Browser |
ModelExplorerTreeContainer |
Tree Container |
ModelingBindingSourceToolboxItem |
ToolboxItem for ModelingBindingSource class |
ModelingCompositionContainer |
Simple class to provide access to the Composition Container that should be used by modeling assets and their extensions |
ModelingDocData |
Abstract base class representing a file in memory that is backed by an IMS store. |
ModelingDocStore |
Class that maintains a 1-1 relationship with the store. Per-store functionality should go here, as opposed to per-file functionality, which should be placed on the ModeingingDocData |
ModelingDocView |
Base class for document windows |
ModelingEditorFactory |
Modeling version of the Editor factory. The editor factory allows the VS shell to get an editor for a particular file type. |
ModelingErrorListItem |
Represents an item that can be handled in ModelingErrorListProvider. |
ModelingErrorListProvider |
ModelingErrorListProvider provides a way for ModelingdocData to report error/warning messages to VS Error List window. |
ModelingPackage |
Toolbox related bits |
ModelingPartitionMapper |
Default Modeling framework partition mapping service. This mapper is capable of mapping to two partitions, one for the model, and one for the diagram. The model partition is assumed to be fixed as the partition of the model root associated with the docdata. The diagram partition may vary, and the particular diagram to use is dynamically determined by looking for a target diagram id in the ElementGroupPrototype's target context. The standard DesignSurfaceElementOperations puts the target diagram over which a drag-over or drop operation occurs into the EGP target context. If the target diagram id is not present in the EGP target context, then this partition mapper assumes that the relevant diagram is the first diagram associated with the model. A limitation of this mapper is that it can only map any particular domain class to a single partition, based upon the first embedding defined for the class. Designers requiring a more sophisticated partition mapping service are free to subclass this partition mapper (it provides a couple of override points), or completely replace it, e.g. by overriding ModelingDocData.CreatePartitionMapper, or by providing it as an SElementPartitionMapper through the service provider provided to the Store at creation time. |
ModelingPartitionMapper.PartitionMappings |
Cache of partition mappings for use during the duration of a mapping operation. Records the model and diagram partitions, and a cache of partition mappings by domain class id. |
ModelingSchemaResolver |
An implementation of ISchemaResolver that resolves schema target namespace to a collection of schemas that define the namespace. |
ModelingWindowPane |
Contains glue for hosting Modeling-based designers in the shell that applies to both tool windows and document views. |
MonitorSelectionEventArgs |
Arguments for events of IMonitorSelectionService. |
NavigateToModelExplorerTreeNodeCommand |
Validation navigation command that navigates to the model explorer window. |
NavigateToShapesOnDiagramCommand | |
PackageUtility | |
ProvideBindingPathAttribute |
This attribute registers a path that should be probed for candidate assemblies at assembly load time. For example: [...\VisualStudio$(Ver)\BindingPaths{5C48C732-5C7F-40f0-87A7-05C4F15BC8C3}] "$PackageFolder$"="" This would register the "PackageFolder" (i.e. the location of the pkgdef file) as a directory to be probed for assemblies to load. |
ProvideCommandLineSwitchAttribute |
Attribute class to provide the registry entries for contributing a command-line switch |
ProvideRelatedFileAttribute |
Attribute class to provide the registry entries for asking the shell to manage the relationship between a nested file and its parent in the solution explorer |
ProvideXmlEditorChooserBlockSxSWithXmlEditorAttribute |
Used to indicate that a custom XML designer should not allow SxS editing with the standard text-based XML editor. |
ProvideXmlEditorChooserDesignerViewAttribute |
Used to provide registration information to the XML Chooser for a custom XML designer. |
RegisterAdditionalEditorExtensionAttribute |
Attribute class to provide a way to add extra file extension handling to existing editors without altering anything else |
RegisterAsDslToolsEditorAttribute |
This attribute is used to tag a DSL Tools Designer that has been created with the Designer Wizard. It enables the Designer Wizard to advise against re-using file extensions handled by other non-DSLTools designers, and enables it to remove old DSL designers without removing other packages that handle the same file extension. |
RoleGroupTreeNode |
RoleGroupTreeNode is the tree node which sits between the parent role player and it’s children in an 1-many embedding domain relationship. The RoleGroupTreeNode text comes from the DomainRole.PropertyDisplayName of the side of the child role player. |
RoleTreeNode |
Model explorer node displayed that displays a relationship with Cardinality of One. |
SerializationErrorListItem |
This class translate a SerializationMessage into a VS Error List window task. |
ShellUtility |
Utility methods for searching solutions and the RDT. |
SimpleErrorListItem |
Subclass to allow simple text messages to be added to the error window. |
SingleDiagramDocView |
Class that hosts a single diagram within a view |
SubordinateDocData |
DocData object that represents a subordinate file in memory (represented as a child project item in the Solution Explorer). |
SubordinateDocumentLockHolder |
Manages an edit lock on a subordinate file in the running documents table. |
SubordinateFileHelper |
Helper methods for managing subordinate files (files that appear nested within project items in the solution explorer). |
TaskMenuCommand |
Represents a menu command entry on the context menu for a validation item in the error list. |
TaskValidationMessage |
TaskValidationMessages are supplied by the VsValidationContext (i.e. ConstructValidationMessage override).
It contains the information to work with the VS ErrorList tool window. It's capable to navigate to the shape |
ToolWindow |
Provides a base class for tool windows. |
UndoManager |
Helper class which wraps the VS shell's undo manager. |
UndoUnit |
Wrapper for Modeling transactions so they can be used by the shell's IOleUndoManager interface. |
UserActionEventArgs |
Event args for passing the information back to the user. |
ValidationMessageCommandIds |
CommandIDs for the Application Designer package. |
ValidationTask |
Validation task. |
ValidationTaskProvider | |
VSDiagramView |
Diagram view hosted inside VS. |
VSDiagramViewSite |
Used to site the design surface control. Provides access to shell services. |
VsValidationContext |
Context specific to the VS Shell. It derives from ValidationContext. |
VsValidationController |
VS model validation controller. |
WaitCursor |
Simple class to put up the Wait cursor during its lifetime. |
Structs
ClassViewNavigationInfoNode |
A single node from a navigation info data object |
QueryEditResult |
Struct that encapsulates the results of a call to IVsQueryEditQuerySave.QueryEditFiles |
QuerySaveResult |
Struct that encapsulates the results of a call to IVsQueryEditQuerySave.QuerySaveFiles |
Interfaces
IMonitorSelectionService |
Monitors current selection state in the shell. |
IRelatedDocList |
Contract for SRelatedDocList that is used to access and manage the RelatedSaveItem list owned by ModelingDocData objects |
IToolWindowProvider | |
SRelatedDocList |
Service identifier for RelatedDocList service used by Modelbus clients. |
Enums
ClassViewNavigationInfoTypes |
Types of navigation info nodes |
DiagramDocView.ToolboxItemFilterType |
Enumeration used to indicate a particular toolbox filter collection. |
ExportUserAction |
public enum represent what type of response is required from the user action. |
IncludeResults |
Enumeration returned from the IncludeInResultsCallback to specify whether current item should be included in the list, and whether search should continue. |
ModelingPartitionMapper.WhichPartition | |
RelatedFileType |
Flag enumeration to specifiy the related file behavior |
Delegates
DescriptionHandler | |
GetModelElementDisplayNameEventHandler |
Delegate call back for allowing the generated designer to proffer an different display name shown in the ModelExplorer |
IncludeInResultsCallback |
Represents the method that will decide if a file should be included in the search results. |
TransactionCommitHandler |
Delegate definitions for committing a transaction and determining a description prior to a transaction commit. |