Microsoft.VisualStudio.Modeling.Shell Namespace

  • Article

The Microsoft.VisualStudio.Modeling.Shell namespace provides classes for the Domain-Specific Language Designer shell. The shell provides an interface to various functions and services through Visual Studio.

You can use the Microsoft.VisualStudio.Modeling.Shell namespace to customize the look of the designer or generated designer for your domain-specific language. For example, you might want to add new commands to menus or create new tabs that display information specific to your project.

Classes

  Class Description
Public class AmbientFontService Provides access to the default font used by designers in Visual Studio.
Public class ClassViewImages Represents an image list used by Class View, Model Explorer, and IntelliSense.
Public class ClassViewNavigationInfo Represents information about each element that can appear in the diagram. Information about each element is displayed as a node in the Class View window.
Public class ClipboardCommandSet Represents a subset of the commands that are available in menus in a domain-specific language. Override methods in YourLanguageClipboardCommandSet to modify how these commands are processed.
Public class CommandContextBoundMenuCommand Represents a menu command that is bound to a specific UI context.
Public class CommandContextChangedEventArgs EventArgs capturing information about a command context change event.
Public class CommandSet Represents a subset of the commands that are available in the menus of a domain-specific language. Override methods in YourLanguageCommandSet to modify how these commands are processed.
Public class CommandSetLibrary Base class for CommandSet and ClipboardCommandSet. Provides access to current selection, diagram, windows and services.
Public class CommonModelingCommands Defines the command IDs of the shared commands in the Domain-Specific Language Designer.
Public class ContainerBase Applies styles to the base tool window and performs common operations, such as setting up borders and watermarks.
Public class CurrentSelectionPusher Class to expose the current selection from a set of Windows Forms Currency Manager Providers or WPF Content Controls to the Visual Studio properties window
Public class DiagramDocView Represents a diagram view in the Domain-Specific Language Designer or generated designer.
Public class DiagramExporter Exports diagrams from the Domain-Specific Language Designer as images.
Public class DialogBase Represents the base class for a dialog box that is hosted in the shell.
Public class DocData When overridden in a derived class, represents a document in memory.
Public class DocumentSavedEventArgs EventArgs class to carry data about a file save operation
Public class DslModelExplorerFilter A filter for use with ElementWalkers.
Public class DynamicStatusMenuCommand Reduces merge conflicts during server integrations when you invoke a menu command.
Public class ElementTreeNode Abstract class of ExplorerTreeNodes that represent ModelElements
Public class ErrorListObserver ErrorListObserver monitors changes after VsValidationController finishes the validation. It reports the error/warning/message in the VS ErrorList and Output window.
Public class ExplorerElementVisitor Represents a visiting function, also known as an element visitor, which traverses the in-memory store (IMS) model and adds nodes to the navigation tree for Model Explorer.
Public class ExplorerTreeNode Represents a node in the Model Explorer tree view.
Public class ExportErrorEventArgs Represents the arguments for the ExportErrorEventArgs class.
Public class FileCancelException Represents the exception that is thrown if a problem occurs when a user cancels a save operation.
Public class LinkedTransaction Manages the opening and closing of a globally linked transaction and any in-memory store (IMS) transactions that are in the linked transaction.
Public class ModelElementLocator Helper class for working with model element references.
Public class ModelElementTreeNode Represents a node for an element in the navigation tree for Model Explorer.
Public class ModelExplorerToolWindow Represents the tool window, which hosts Model Explorer.
Public class ModelExplorerTreeContainer Represents Model Explorer, which contains a tree view in alphabetical order of all elements in a model.
Public class ModelingBindingSourceToolboxItem ToolboxItem for ModelingBindingSource class
Public class ModelingCompositionContainer Simple class to provide access to the Composition Container that should be used by modeling assets and their extensions
Public class ModelingDocData Represents a document in the Store.
Public class ModelingDocStore Represents a model's in-memory elements and links.
Public class ModelingDocView Represents a document window in the Domain-Specific Language Designer or generated designer.
Public class ModelingEditorFactory Provides support for the modeling editor factory, which enables the Visual Studio shell to obtain an editor for a specific file type.
Public class ModelingErrorListItem Represents an item that can be handled in ModelingErrorListProvider.
Public class ModelingErrorListProvider ModelingErrorListProvider provides a way for ModelingdocData to report error/warning messages to VS Error List window.
Public class ModelingPackage When overridden in a derived class, represents the VSPackage for the Domain-Specific Language Designer.
Public class ModelingPartitionMapper Determines the partition for a particular model element or class.
Protected class 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.
Public class ModelingSchemaResolver An implementation of ISchemaResolver that resolves schema target namespace to a collection of schemas that define the namespace.
Public class ModelingWindowPane Provides selection service and selection event notification for both tool windows and document views.
Public class MonitorSelectionEventArgs Represents arguments for the monitor selection service.
Public class NavigateToModelExplorerTreeNodeCommand Validation navigation command that navigates to the model explorer window.
Public class NavigateToShapesOnDiagramCommand
Public class PackageUtility
Public class ProvideBindingPathAttribute This attribute allows the assemblies in your Visual Studio Package or Extension to be used by other packages and extensions. It adds the directory where your package is installed to the Visual Studio probing list, which is used to resolve assembly references.
Public class ProvideCommandLineSwitchAttribute Provides registry entries for a command-line switch.
Public class 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
Public class ProvideXmlEditorChooserBlockSxSWithXmlEditorAttribute Used to indicate that a custom XML designer should not allow SxS editing with the standard text-based XML editor.
Public class ProvideXmlEditorChooserDesignerViewAttribute Used to provide registration information to the XML Chooser for a custom XML designer.
Public class RegisterAdditionalEditorExtensionAttribute Attribute class to provide a way to add extra file extension handling to existing editors without altering anything else
Public class 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.
Public class RoleGroupTreeNode Represents the node that contains the child roles for a parent role in the navigation tree for Model Explorer.
Public class RoleTreeNode Model explorer node displayed that displays a relationship with Cardinality of One.
Public class SerializationErrorListItem This class translate a SerializationMessage into a VS Error List window task.
Public class ShellUtility Utility methods for searching solutions and the RDT.
Public class SimpleErrorListItem Subclass to allow simple text messages to be added to the error window.
Public class SingleDiagramDocView When overridden in a derived class, displays a single diagram in a document view.
Public class SubordinateDocData DocData object that represents a subordinate file in memory (represented as a child project item in the Solution Explorer).
Public class SubordinateDocumentLockHolder Manages an edit lock on a subordinate file in the running documents table.
Public class SubordinateFileHelper Helper methods for managing subordinate files (files that appear nested within project items in the solution explorer).
Public class TaskMenuCommand Represents a menu command entry on the context menu for a validation item in the error list.
Public class TaskValidationMessage Represents a validation error, warning, or information message.
Public class ToolWindow When overridden by a derived class, represents a tool window in the generated designer for a domain-specific language.
Public class UndoManager Helper class which wraps the Visual Studio shell's undo manager.
Public class UndoUnit Wrapper for Modeling transactions so they can be used by the shell's IOleUndoManager interface.
Public class UserActionEventArgs Event args for passing the information back to the user.
Public class ValidationMessageCommandIds CommandIDs for the Application Designer package.
Public class ValidationTask Validation task.
Public class ValidationTaskProvider
Public class VSDiagramView Represents the diagram view that Visual Studio hosts.
Public class VSDiagramViewSite Used to site the design surface control. Provides access to shell services.
Public class VsValidationContext Context specific to the VS Shell. It derives from ValidationContext.
Public class VsValidationController VS model validation controller.
Public class WaitCursor Displays the Wait cursor while an instance exists, and restores the original cursor when it is disposed.

Structures

  Structure Description
Public structure ClassViewNavigationInfoNode Represents an element that appears as a node in a tree view.
Public structure QueryEditResult Manages the results when there is a request to modify the document, and encapsulates the results of a call to QueryEditFiles.
Public structure QuerySaveResult Manages the results when there is a request to save the document, and encapsulates the results of a call to QuerySaveFiles.

Interfaces

  Interface Description
Public interface IMonitorSelectionService Monitors the current selection state in the shell.
Public interface IRelatedDocList List of documents related to another document.
Public interface SRelatedDocList Service identifier for RelatedDocList service used by Modelbus clients.

Delegates

  Delegate Description
Public delegate DescriptionHandler Invoked to determine the description of a transaction.
Public delegate GetModelElementDisplayNameEventHandler Call back that allows you to define the element name displayed in Model Explorer.
Public delegate IncludeInResultsCallback Represents the method that will decide if a file should be included in the search results.
Public delegate TransactionCommitHandler Invoked when a transaction is committed.

Enumerations

  Enumeration Description
Public enumeration ClassViewNavigationInfoTypes Represents the types of nodes to which you can assign an element in the navigation tree.
Protected enumeration DiagramDocView.ToolboxItemFilterType Enumeration used to indicate a particular toolbox filter collection.
Public enumeration ExportUserAction Represents the type of problem that requires the user's attention.
Public enumeration IncludeResults Enumeration returned from the IncludeInResultsCallback to specify whether current item should be included in the list, and whether search should continue.
Protected enumeration ModelingPartitionMapper.WhichPartition
Public enumeration RelatedFileType Flag enumeration to specifiy the related file behavior