SpreadsheetControl.SetSelectedShapes(IList<Shape>) Method

Select specified shapes in the active worksheet.

Namespace: DevExpress.Xpf.Spreadsheet

Assembly: DevExpress.Xpf.Spreadsheet.v24.1.dll

NuGet Package: DevExpress.Wpf.Spreadsheet

Declaration

C#

public bool SetSelectedShapes(
    IList<Shape> Shapes
)

VB.NET

Public Function SetSelectedShapes(
    Shapes As IList(Of Shape)
) As Boolean

Parameters

Name	Type	Description
Shapes	IList<Shape>	A list of Shape objects.

Returns

Type	Description
Boolean	true if shapes are selected successfully; otherwise false. If you pass null (Nothing in Visual Basic), or an empty list, or a list that contains at least one shape located in a worksheet other than the active worksheet, the method returns false.

Remarks

All shapes in a worksheet are contained in the ShapeCollection, accessible via the Worksheet.Shapes property. Use the SetSelectedShapes method to select multiple shapes in the active worksheet simultaneously. To get the list of shapes selected in the active worksheet, use the SpreadsheetControl.GetSelectedShapes method. To specify whether multi-selection is available to end-users in the SpreadsheetControl, use the SpreadsheetSelectionOptions.AllowMultiSelection option accessible via the SpreadsheetControl.Options.Behavior.AllowMultiSelection notation.

Note

To select shapes in a specific worksheet (which may or may not be active) of the document loaded in the SpreadsheetControl, use the Worksheet.SetSelectedShapes method of the worksheet object.