SpreadsheetControl.SelectionChanged Event

Fires when the selection changes in an active worksheet.

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v19.1.dll

Declaration

C#

public event EventHandler SelectionChanged

VB.NET

Public Event SelectionChanged As EventHandler

Event Data

The SelectionChanged event's data class is EventArgs.

Remarks

Handle the SelectionChanged event to perform any actions each time a user selects cells, rows, columns, or drawing objects in the SpreadsheetControl’s UI.

Set the WorkbookEventOptions.RaiseOnModificationsViaAPI property to true to raise the SelectionChanged event when the selection is changed in code.

C#

spreadsheetControl.Options.Events.RaiseOnModificationsViaAPI = true;

VB.NET

spreadsheetControl.Options.Events.RaiseOnModificationsViaAPI = True

Use the following API members to specify the selection:

• SpreadsheetControl.SelectedCell, Worksheet.SelectedCell - allow you to specify an active cell.

• SpreadsheetControl.Selection, Worksheet.Selection - allow you to select the continuous cell range.

• SpreadsheetControl.SetSelectedRanges, Worksheet.SetSelectedRanges - allow you to select multiple non-adjacent cell ranges.

• Worksheet.SelectedChart - specifies the selected chart.

• SpreadsheetControl.SelectedPicture, Worksheet.SelectedPicture - allow you to select a picture.

• SpreadsheetControl.SelectedShape, Worksheet.SelectedShape - allow you to select a drawing object.

• SpreadsheetControl.SetSelectedShapes, Worksheet.SetSelectedShapes - allow you to select multiple drawing objects.

Example

The example below shows how to use the SelectionChanged event to calculate the average, count, numerical count and sum for non-empty selected cells.

C#

spreadsheetControl1.SelectionChanged += (s, e) =>
{
    int count = 0;
    double sum = 0.0;
    int numericCount = 0;
    double average = 0.0;

    Worksheet worksheet = spreadsheetControl1.ActiveWorksheet;
    Range selectedCells = worksheet.Selection.Intersect(worksheet.GetDataRange());
    if (selectedCells != null)
    {
        foreach (Cell cell in selectedCells.ExistingCells)
        {
            count++;
            if (cell.Value.IsNumeric)
            {
                numericCount++;
                sum += cell.Value.NumericValue;
            }
        }
    }
    if (numericCount > 0)
        average = sum / numericCount;
};

VB.NET

AddHandler spreadsheetControl1.SelectionChanged,
    Sub(s, e)
        Dim count As Integer = 0
        Dim sum As Double = 0.0
        Dim numericCount As Integer = 0
        Dim average As Double = 0.0

        Dim worksheet As Worksheet = spreadsheetControl1.ActiveWorksheet
        Dim selectedCells As Range = worksheet.Selection.Intersect(worksheet.GetDataRange())
        If selectedCells IsNot Nothing Then
            For Each cell As Cell In selectedCells.ExistingCells
                count += 1
                If cell.Value.IsNumeric Then
                    numericCount += 1
                    sum += cell.Value.NumericValue
                End If
            Next cell
        End If
        If numericCount > 0 Then
            average = sum / numericCount
        End If
    End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SelectionChanged event.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/CS/SpreadsheetCustomization/Form1.cs#L34

spreadsheetControl1.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheetControl1.CellBeginEdit +=spreadsheetControl1_CellBeginEdit;

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/CS/SpreadsheetCustomization/Form1.cs#L42

spreadsheetControl1.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheetControl1.CellBeginEdit += spreadsheetControl1_CellBeginEdit;

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/CS/WindowsFormsApplication1/FormatPainterProvider.cs#L25

spreadsheet.PreviewKeyDown += spreadsheetControl1_PreviewKeyDown;
spreadsheet.SelectionChanged += spreadsheetControl1_SelectionChanged;
spreadsheet.CellBeginEdit += spreadsheetControl1_CellBeginEdit;

VB.NET

how-to-display-a-custom-control-over-the-worksheet-cell-t208764/VB/SpreadsheetCustomization/Form1.vb#L33

AddHandler spreadsheetControl1.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheetControl1.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit

how-to-display-custom-controls-instead-of-the-standard-cell-editor-t259398/VB/SpreadsheetCustomization/Form1.vb#L44

AddHandler spreadsheetControl1.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheetControl1.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit

how-to-implement-the-basic-idea-of-the-microsoft-excel-format-painter-feature-for-spreadsh-t590741/VB/WindowsFormsApplication1/FormatPainterProvider.vb#L27

AddHandler spreadsheet.PreviewKeyDown, AddressOf spreadsheetControl1_PreviewKeyDown
AddHandler spreadsheet.SelectionChanged, AddressOf spreadsheetControl1_SelectionChanged
AddHandler spreadsheet.CellBeginEdit, AddressOf spreadsheetControl1_CellBeginEdit