Back to Devexpress

DashboardExtractDataSource Members

dashboard-devexpress-dot-dashboardcommon-dot-dashboardextractdatasource-dot-underscore-members.md

latest7.3 KB
Original Source

DashboardExtractDataSource Members

An extract data source that is a local snapshot of data.

Constructors

NameDescription
DashboardExtractDataSource()Initializes a new instance of the DashboardExtractDataSource class.
DashboardExtractDataSource(String, String)Initializes a new instance of the DashboardExtractDataSource class.
DashboardExtractDataSource(String)Initializes a new instance of the DashboardExtractDataSource class.

Properties

NameDescription
CalculatedFieldsProvides access to a data source’s calculated fields.
ComponentNameGets or sets the component name of the data source.
ConnectionNameSpecifies the name of the created connection to an Extract Data Source.
DriverNameGets or sets a custom driver used to write data to/read data from the current data extract.
ExtractSourceOptionsProvides access to settings of the original data source used to create a data extract.
FileNameGets or sets the path to the file containing a data extract.
FilterSpecifies the logical expression that filters data to be displayed in a dashboard.
NameGets or sets the data source name.

Methods

NameDescription
BeginInit()For internal use.
Dispose()Releases resources associated with a DashboardExtractDataSource instance.
EndInit()For internal use.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
Fill(IEnumerable<IParameter>)Retrieves the data from the connected data source with the specified parameters.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetType()Gets the Type of the current instance. Inherited from Object.
LoadFromXml(XElement)Loads the data source schema definition from XML.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SaveToXml()Saves the XML definition of the extract data source schema.
ToString()Returns a string that represents the current object. Inherited from Object.
UpdateExtractFile()Updates data in the data extract file.
UpdateExtractFile(CancellationToken, String, String)Updates a file containing a data extract and allows you to specify the driver used to write data to the data extract.
UpdateExtractFile(CancellationToken)Updates a data extract file and allows you to cancel the update task through the use of a cancellation token.
UpdateFile(DashboardExtractDataSource, Action<String, ExtractUpdateResult>, Action<String, ExtractUpdateResult>) staticStatic method to update data in the data extract file. Allows you to prevent access to the file until the data is refreshed and the file is re-created.

Events

NameDescription
BeforeFillProvides the capability to change options used to fill the extract data source.
ConnectionErrorAllows users to override the default behavior if connection to a data extract file fails with current connection parameters.
DisposedFor internal use.

See Also

DashboardExtractDataSource Class

DevExpress.DashboardCommon Namespace