DiagramSelectionRules.GetCompliantSelection Method

Called by the design surface to allow selection filtering

Namespace:  Microsoft.VisualStudio.Modeling.Diagrams
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0 (in Microsoft.VisualStudio.Modeling.Sdk.Diagrams.10.0.dll)

Syntax

'Declaration
Public Overridable Function GetCompliantSelection ( _
    currentSelection As SelectedShapesCollection, _
    proposedItemsToAdd As DiagramItemCollection, _
    proposedItemsToRemove As DiagramItemCollection, _
    primaryItem As DiagramItem _
) As Boolean

public virtual bool GetCompliantSelection(
    SelectedShapesCollection currentSelection,
    DiagramItemCollection proposedItemsToAdd,
    DiagramItemCollection proposedItemsToRemove,
    DiagramItem primaryItem
)

public:
virtual bool GetCompliantSelection(
    SelectedShapesCollection^ currentSelection, 
    DiagramItemCollection^ proposedItemsToAdd, 
    DiagramItemCollection^ proposedItemsToRemove, 
    DiagramItem^ primaryItem
)

abstract GetCompliantSelection : 
        currentSelection:SelectedShapesCollection * 
        proposedItemsToAdd:DiagramItemCollection * 
        proposedItemsToRemove:DiagramItemCollection * 
        primaryItem:DiagramItem -> bool 
override GetCompliantSelection : 
        currentSelection:SelectedShapesCollection * 
        proposedItemsToAdd:DiagramItemCollection * 
        proposedItemsToRemove:DiagramItemCollection * 
        primaryItem:DiagramItem -> bool 

public function GetCompliantSelection(
    currentSelection : SelectedShapesCollection, 
    proposedItemsToAdd : DiagramItemCollection, 
    proposedItemsToRemove : DiagramItemCollection, 
    primaryItem : DiagramItem
) : boolean

Parameters

• currentSelection
  Type: Microsoft.VisualStudio.Modeling.Diagrams.SelectedShapesCollection
  [in] The current selection before any ShapeElements are added or removed.

• proposedItemsToAdd
  Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramItemCollection
  [in/out] The proposed DiagramItems to be added to the selection.

• proposedItemsToRemove
  Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramItemCollection
  [in/out] The proposed DiagramItems to be removed from the selection.

• primaryItem
  Type: Microsoft.VisualStudio.Modeling.Diagrams.DiagramItem
  [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.

Return Value

Type: System.Boolean

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

DiagramSelectionRules Class

Microsoft.VisualStudio.Modeling.Diagrams Namespace