Back to Devexpress

RealTimeDataOptions.ThrottleInterval Property

officefileapi-devexpress-dot-xtraspreadsheet-dot-realtimedataoptions-1bc23def.md

latest3.4 KB
Original Source

RealTimeDataOptions.ThrottleInterval Property

Gets or sets the time interval between updates.

Namespace : DevExpress.XtraSpreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
[DefaultValue(500)]
public int ThrottleInterval { get; set; }
vb
<DefaultValue(500)>
Public Property ThrottleInterval As Integer

Property Value

TypeDefaultDescription
Int32500

An integer that is the time interval in milliseconds.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to ThrottleInterval
DocumentOptions

.RealTimeData .ThrottleInterval

|

Remarks

The ThrottleInterval value is in effect only when the RealTimeDataOptions.RefreshMode is set to the RealTimeDataRefreshMode.ByTimer value.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ThrottleInterval 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.

how-to-implement-real-time-data-server-and-use-rtd-worksheet-function/CS/TestRTDClient/Form1.cs#L19

csharp
private void barEditSpinThrottleInterval_EditValueChanged(object sender, EventArgs e) {
    spreadsheetControl1.Options.RealTimeData.ThrottleInterval = Int32.Parse(barEditSpinThrottleInterval.EditValue.ToString());
}

how-to-implement-real-time-data-server-and-use-rtd-worksheet-function/VB/TestRTDClient/Form1.vb#L19

vb
Private Sub barEditSpinThrottleInterval_EditValueChanged(ByVal sender As Object, ByVal e As EventArgs) Handles barEditSpinThrottleInterval.EditValueChanged
    spreadsheetControl1.Options.RealTimeData.ThrottleInterval = Int32.Parse(barEditSpinThrottleInterval.EditValue.ToString())
End Sub

See Also

RealTimeDataOptions Class

RealTimeDataOptions Members

DevExpress.XtraSpreadsheet Namespace