How to: Access and Constrain the Current Selection

Article
11/15/2016

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

When you write a command or gesture handler for your domain-specific language, you can determine what element the user right-clicked. You can also prevent some shapes or fields from being selected. For example, you can arrange that when the user clicks an icon decorator, the shape that contains it is selected instead. Constraining the selection in this manner reduces the number of handlers that you have to write. It also makes it easier for the user, who can click anywhere in the shape without having to avoid the decorator.

Accessing the Current Selection from a Command Handler

The command set class for a domain-specific language contains the command handlers for your custom commands. The CommandSet class, from which the command set class for a domain-specific language derives, provides a few members for accessing the current selection.

Depending on the command, the command handler might need the selection in the model designer, the model explorer, or the active window.

To access selection information

The CommandSet class defines the following members that can be used to access the current selection.

Member	Description
IsAnyDocumentSelectionCompartment method	Returns `true` if any of the elements selected in the model designer is a compartment shape; otherwise, `false`.
IsDiagramSelected method	Returns `true` if the diagram is selected in the model designer; otherwise, `false`.
IsSingleDocumentSelection method	Returns `true` if exactly one element is selected in the model designer; otherwise, `false`.
IsSingleSelection method	Returns `true` if exactly one element is selected in the active window; otherwise, `false`.
CurrentDocumentSelection property	Gets a read-only collection of the elements selected in the model designer.
CurrentSelection property	Gets a read-only collection of the elements selected in the active window.
SingleDocumentSelection property	Gets the primary element of the selection in the model designer.
SingleSelection property	Gets the primary element of the selection in the active window.

The CurrentDocView property of the CommandSet class provides access to the DiagramDocView object that represents the model designer window and provides additional access the selected elements in the model designer.
In addition, the generated code defines an explorer tool window property and an explorer selection property in the command set class for the domain-specific language.
- The explorer tool window property returns an instance of the explorer tool window class for the domain-specific language. The explorer tool window class derives from the ModelExplorerToolWindow class and represents the model explorer for the domain-specific language.
- The ExplorerSelection property returns the selected element in the model explorer window for the domain-specific language.

Determining which window is active

The IMonitorSelectionService interface contains defines members that provide access to the current selection state in the shell. You can get an IMonitorSelectionService object from either the package class or the command set class for the domain-specific language through the MonitorSelection property defined in the base class of each. The package class derives from the ModelingPackage class, and the command set class derives from the CommandSet class.

To determine from a command handler what type of window is active

The MonitorSelection property of the CommandSet class returns an IMonitorSelectionService object that provides access to the current selection state in the shell.
The CurrentSelectionContainer property of the IMonitorSelectionService interface gets the active selection container, which can be different from the active window.

Add the following properties to the command set class for you domain-specific language to determine what type of window is active.

// using Microsoft.VisualStudio.Modeling.Shell;

// Returns true if the model designer is the active selection container;
// otherwise, false.
protected bool IsDesignerActive
{
    get
    {
        return (this.MonitorSelection.CurrentSelectionContainer
            is DiagramDocView);
    }
}

// Returns true if the model explorer is the active selection container;
// otherwise, false.
protected bool IsExplorerActive
{
    get
    {
        return (this.MonitorSelection.CurrentSelectionContainer
            is ModelExplorerToolWindow);
    }
}

Constraining the Selection

By adding selection rules, you can control which elements are selected when the user selects an element in the model. For example, to allow the user to treat a number of elements as a single unit, you can use a selection rule.

To create a selection rule

Create a custom code file in the DSL project
Define a selection rule class that is derived from the DiagramSelectionRules class.
Override the GetCompliantSelection method of the selection rule class to apply the selection criteria.
Add a partial class definition for the ClassDiagram class to your custom code file.

The ClassDiagram class derives from the Diagram class and is defined in the generated code file, Diagram.cs, in the DSL project.
Override the SelectionRules property of the ClassDiagram class to return the custom selection rule.

The default implementation of the SelectionRules property gets a selection rule object that does not modify the selection.

Example

The following code file creates a selection rule that expands the selection to include all instances of each of the domain shapes that was initially selected.

using System;
using System.Collections.Generic;
using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Diagrams;

namespace CompanyName.ProductName.GroupingDsl
{
    public class CustomSelectionRules : DiagramSelectionRules
    {
        protected Diagram diagram;
        protected IElementDirectory elementDirectory;

        public CustomSelectionRules(Diagram diagram)
        {
            if (diagram == null) throw new ArgumentNullException();

            this.diagram = diagram;
            this.elementDirectory = diagram.Store.ElementDirectory;
        }

        /// <summary>Called by the design surface to allow selection filtering.
        /// </summary>
        /// <param name="currentSelection">[in] The current selection before any
        /// ShapeElements are added or removed.</param>
        /// <param name="proposedItemsToAdd">[in/out] The proposed DiagramItems to
        /// be added to the selection.</param>
        /// <param name="proposedItemsToRemove">[in/out] The proposed DiagramItems
        /// to be removed from the selection.</param>
        /// <param name="primaryItem">[in/out] The proposed DiagramItem to become
        /// the primary DiagramItem of the selection. A null value signifies that
        /// the last DiagramItem in the resultant selection should be assumed as
        /// the primary DiagramItem.</param>
        /// <returns>true if some or all of the selection was accepted; false if
        /// the entire selection proposal was rejected. If false, appropriate
        /// feedback will be given to the user to indicate that the selection was
        /// rejected.</returns>
        public override bool GetCompliantSelection(
            SelectedShapesCollection currentSelection,
            DiagramItemCollection proposedItemsToAdd,
            DiagramItemCollection proposedItemsToRemove,
            DiagramItem primaryItem)
        {
            if (currentSelection.Count == 0 && proposedItemsToAdd.Count == 0) return true;

            HashSet<DomainClassInfo> itemsToAdd = new HashSet<DomainClassInfo>();

            foreach (DiagramItem item in proposedItemsToAdd)
            {
                if (item.Shape != null)
                    itemsToAdd.Add(item.Shape.GetDomainClass());
            }
            proposedItemsToAdd.Clear();
            foreach (DomainClassInfo classInfo in itemsToAdd)
            {
                foreach (ModelElement element
                    in this.elementDirectory.FindElements(classInfo, false))
                {
                    if (element is ShapeElement)
                    {
                        proposedItemsToAdd.Add(
                            new DiagramItem((ShapeElement)element));
                    }
                }
            }

            return true;
        }
    }

    public partial class ClassDiagram
    {
        protected CustomSelectionRules customSelectionRules = null;

        protected bool multipleSelectionMode = true;

        public override DiagramSelectionRules SelectionRules
        {
            get
            {
                if (multipleSelectionMode)
                {
                    if (customSelectionRules == null)
                    {
                        customSelectionRules = new CustomSelectionRules(this);
                    }
                    return customSelectionRules;
                }
                else
                {
                    return base.SelectionRules;
                }
            }
        }
    }
}

Share via