ChartControl.SetObjectSelection(Object) Method

Selects the specified chart element at runtime.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.UI.dll

NuGet Package: DevExpress.Win.Charts

Declaration

C#

public void SetObjectSelection(
    object obj
)

VB.NET

Public Sub SetObjectSelection(
    obj As Object
)

Parameters

Name	Type	Description
obj	Object	A Object which specifies the chart element to select.

Remarks

Use the SetObjectSelection method to implement custom selection of chart elements at runtime. To clear the selection of any chart element, the ChartControl.ClearSelection method should be used.

Note

To enable standard selection of chart elements by end-users at runtime, set the ChartControl.RuntimeSelection property to true.

Example

This example demonstrates how to select a specific object (diagram, axis, series point, etc.) in a Windows Forms chart.

To do this, it is necessary to call the ChartControl.SetObjectSelection method with an object to select as its parameter, and then call the ChartControl.Refresh method.

Form1.cs

using System;
using System.Windows.Forms;
using DevExpress.XtraCharts;

namespace SetSelection {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void btnDiagram_Click(object sender, EventArgs e) {
            // Select a diagram.
            chartControl1.SetObjectSelection(chartControl1.Diagram);
        }

        private void btnAxis_Click(object sender, EventArgs e) {
            // Select an axis.
            chartControl1.SetObjectSelection(((XYDiagram)chartControl1.Diagram).AxisX);
        }

        private void btnSeriesPoint_Click(object sender, EventArgs e) {
            // Select a series point.
            SeriesPoint pointToSelect = this.chartControl1.Series[0].Points[1] as SeriesPoint;
            if (pointToSelect != null) {
                this.chartControl1.SetObjectSelection(pointToSelect);
            }
        }
    }
}

Form1.vb

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraCharts

Namespace SetSelection
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub btnDiagram_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnDiagram.Click
            ' Select a diagram.
            chartControl1.SetObjectSelection(chartControl1.Diagram)
        End Sub

        Private Sub btnAxis_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnAxis.Click
            ' Select an axis.
            chartControl1.SetObjectSelection(CType(chartControl1.Diagram, XYDiagram).AxisX)
        End Sub

        Private Sub btnSeriesPoint_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnSeriesPoint.Click
            ' Select a series point.
            Dim pointToSelect As SeriesPoint = TryCast(Me.chartControl1.Series(0).Points(1), SeriesPoint)
            If pointToSelect IsNot Nothing Then
                Me.chartControl1.SetObjectSelection(pointToSelect)
            End If
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the SetObjectSelection(Object) method.

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-show-chart-legend-with-markers-in-separate-control-e2366/CS/Form1.cs#L79

{
    chart.SetObjectSelection(gridView1.GetRow(e.FocusedRowHandle));
}

VB.NET

how-to-show-chart-legend-with-markers-in-separate-control-e2366/VB/Form1.vb#L77

Private Sub gridView1_FocusedRowChanged(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.FocusedRowChangedEventArgs) Handles gridView1.FocusedRowChanged
    chart.SetObjectSelection(gridView1.GetRow(e.FocusedRowHandle))
End Sub