RangeControl.Client Property

Gets or sets the object that visualizes its data within the RangeControl’s viewport.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DefaultValue(null)]
[DXCategory("Behavior")]
public IRangeControlClient Client { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Behavior")>
Public Property Client As IRangeControlClient

Property Value

Type	Default	Description
IRangeControlClient	*null*	An IRangeControlClient object that visualizes its data within the RangeControl’s viewport.

Remarks

Data for the Range Control is provided by a Range Control Client, which must be associated with the Range Control by using the RangeControl.Client property. The client also visualizes data in the Range Control’s viewport in a specific manner. Embedded into the Range Control, the client automatically gains support for range selection and zooming.

The following Range Control Clients are available out of the box.

• NumericRangeControlClient - A RangeControl‘s client that supports numeric (integer, double, decimal or float) range selection.

  

• NumericChartRangeControlClient - The RangeControl‘s client that renders a lightweight chart with a numeric horizontal axis.

  

• DateTimeChartRangeControlClient - The RangeControl‘s client that renders a lightweight chart with a date-time horizontal axis.

  

• SchedulerControl - When using this client, the Range Control allows end-users to select date ranges for the associated Scheduler Control. See Scheduler Range Control.
• ChartControl - When using this client, the Range Control allows end-users to select ranges for the associated Chart Control. See Integration with a Range Control.

To embed a NumericRangeControlClient, NumericChartRangeControlClient or DateTimeChartRangeControlClient into the Range Control at design time, use the Range Control’s smart tag.

When required, you can implement your own Range Control Client that will display data in a custom manner within the Range Control. See the Custom Range Control Client topic to learn more.

Related GitHub Examples

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

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#

creating-rangecontrolclient-that-paints-custom-information-in-rangecontrol-e4028/CS/Form1.cs#L17

private void Form1_Load(object sender, EventArgs e) {
    rangeControl1.Client = new CustomRangeClient(101, -100, 100);

how-to-customize-grid-lines-grid-snapping-of-the-chart-range-control-client-t129232/CS/Form1.cs#L17

// Specify a Chart control as the Range control client.
rangeControl1.Client = chartControl1;

how-to-customize-series-of-a-chart-range-control-client-at-runtime-t130182/CS/ChartClientCustomizeSeries/Form1.cs#L49

// Assign a numeric chart client to the Range control.
rangeControl1.Client = numericChartRangeControlClient1;

how-to-bind-a-schedulerstorage-to-a-rangecontrol-e4093/CS/Form1.cs#L20

// Bind the scheduler storage to the RangeControl.
rangeControl.Client = Client;

VB.NET

creating-rangecontrolclient-that-paints-custom-information-in-rangecontrol-e4028/VB/Form1.vb#L19

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
    rangeControl1.Client = New CustomRangeClient(101, -100, 100)

how-to-customize-series-of-a-chart-range-control-client-at-runtime-t130182/VB/ChartClientCustomizeSeries/Form1.vb#L50

' Assign a numeric chart client to the Range control.
rangeControl1.Client = numericChartRangeControlClient1

how-to-bind-a-schedulerstorage-to-a-rangecontrol-e4093/VB/Form1.vb#L22

' Bind the scheduler storage to the RangeControl.
rangeControl.Client = Client