officefileapi-devexpress-dot-xtraspreadsheet-dot-realtimedataoptions.md
Gets or sets a value that indicates how the update of the real time data is initiated.
Namespace : DevExpress.XtraSpreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
[DefaultValue(RealTimeDataRefreshMode.ByTimer)]
public RealTimeDataRefreshMode RefreshMode { get; set; }
<DefaultValue(RealTimeDataRefreshMode.ByTimer)>
Public Property RefreshMode As RealTimeDataRefreshMode
| Type | Default | Description |
|---|---|---|
| RealTimeDataRefreshMode | ByTimer |
A RealTimeDataRefreshMode enumeration member that specifies the update initiator.
|
Available values:
| Name | Description |
|---|---|
| Manual |
Real time data is updated on demand by calling the RealTimeData.RefreshData method.
| | ByTimer |
Real time data is updated by a timer after the time interval specified by the RealTimeDataOptions.ThrottleInterval property.
|
You can access this nested property as listed below:
| Object Type | Path to RefreshMode |
|---|---|
| DocumentOptions |
.RealTimeData .RefreshMode
|
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the RefreshMode 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#L15
RealTimeDataRefreshMode mode = (RealTimeDataRefreshMode)Enum.Parse(typeof(RealTimeDataRefreshMode), barEditRefreshMode.EditValue.ToString());
spreadsheetControl1.Options.RealTimeData.RefreshMode = mode;
}
how-to-implement-real-time-data-server-and-use-rtd-worksheet-function/VB/TestRTDClient/Form1.vb#L15
Dim mode As RealTimeDataRefreshMode = DirectCast(System.Enum.Parse(GetType(RealTimeDataRefreshMode), barEditRefreshMode.EditValue.ToString()), RealTimeDataRefreshMode)
spreadsheetControl1.Options.RealTimeData.RefreshMode = mode
End Sub
See Also