GeneralSelection Class

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Modeling.Diagrams
Assembly:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams.15.0.dll
Assembly:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams.dll
Package:
Microsoft.VisualStudio.Modeling.Sdk.Diagrams v17.10.40171

Handles general selections not covered by other selection states.

public ref class GeneralSelection : Microsoft::VisualStudio::Modeling::Diagrams::SelectionState
public class GeneralSelection : Microsoft.VisualStudio.Modeling.Diagrams.SelectionState
type GeneralSelection = class
    inherit SelectionState
Public Class GeneralSelection
Inherits SelectionState
Inheritance
Object
SelectionState
GeneralSelection

Constructors

GeneralSelection()

constructor

Properties

ActualSelection

Gets the actual selection.

(Inherited from SelectionState)
CoercedSelection

Gets the coerced selection by applying coercion rules to the actual selection.

NOTE: The returned value can be null. A null coercion indicates that the selection state doesn't define coercion rules (i.e. a multiple seleciton including only
comment connectors is covered by the GeneralSelection state, which doesn't define any coercions rules, so the seleciton's coercion is null).

If coercion rules are defined for a selection state, but the coercion fails (as would be the case for a selection including several components belonging to different zones), the coerced selection exists but is empty.

These helpers can be used to demystify the results of coercing a selection:

  • IsCoercible - true if the seleciton can be coerced (i.e. the selection state does define coercion rules). CoercedSelection will return a collection, but it may be empty.
  • IsCoercionFailure - true if the actual selection can be coerced, but the coercion fails (due coercion rules.) CoercedSelection will be an empy collection.
  • HasCoercion - true if the actual selection is coercable and its coercion does not fail. CoercedSelection will return a non-empty collection.
(Inherited from SelectionState)
CoercedSelectionCache

cache for the coerced selection

(Inherited from SelectionState)
CoercedSelectionModelElements

It is possible for the CoercedSelection to include Pels and Mels which are
associated with Pels that are not already included.

This method returns a list that replaces the Pels in the coerced selection with their associated Mels, plus any mels from the coerced selection that did not have pels.

(Inherited from SelectionState)
CoercedSelectionPresentationElements

It is possible for the CoercedSelection to include Pels and Mels which are
associated with Pels that are not already included.

This method returns a collection which excludes any Mels.

(Inherited from SelectionState)
CoercionCompliantSelection

Returns the list of selected objects which comply with the coercion rules. If the selection is coercable, then the coerced selection will be returned; if there is a coercion failure the list will be empty. If there are no coercion rules (!IsCoercable), then the actual selection is returned.

(Inherited from SelectionState)
HasCoercion

Determines if the selection has a valid coercion.

(Inherited from SelectionState)
IsActualSelectionMixed

True if all selected objects in the actual selection are of the same type.

(Inherited from SelectionState)
IsCoercedSelectionMixed

True if all selected objects in the coerced selection are of the same type.

(Inherited from SelectionState)
IsCoercible

Determines if the actual selection can be coerced. Togegher IsCoercible and IsCoercionFailure distinguish between coercion failure, and no coercion available.

(Inherited from SelectionState)
IsCoercionFailure

Togegher IsCoercible and IsCoercionFailure distinguish between coercion failure, and no coercion available.

(Inherited from SelectionState)

Methods

CacheCoercedSelection(ICollection)

Cache the specified collection.

(Inherited from SelectionState)
IdentifyCommandsToBeFilteredOutForMultipleSelection(CommandIdCollection)

Override to identify the commands which are not valid.
IdentifyCommandsToBeFilteredOutForSingleSelection(CommandIdCollection)

Override to identify the commands which are not valid in a single selection scenario, for this selection state.

(Inherited from SelectionState)
Initialize(ICollection)

specifies the actual selection to operate upon.

(Inherited from SelectionState)
IsApplicable(ICollection)

Determines if this selection state is apppropriate for use with the specified selection.
IsCommandToBeFilteredOut(CommandID)

True if the specified command should not be enabled for this selection state. The method is evaluated for the coerced selection.

(Inherited from SelectionState)
IsCommandToBeFilteredOutForMultipleSelection(CommandID)

True if the specified command should not be enabled for this selection state. The method is evaluated for the coerced selection.
IsCommandToBeFilteredOutForSingleSelection(CommandID)

True if the specified command should not be enabled for this selection state. The method is evaluated for the coerced selection.

(Inherited from SelectionState)

Applies to