Back to Devexpress

DashboardSqlDataSource Members

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

latest25.1 KB
Original Source

DashboardSqlDataSource Members

An SQL data source that provides data for the dashboard.

Constructors

NameDescription
DashboardSqlDataSource()Initializes a new instance of the DashboardSqlDataSource class with default settings.
DashboardSqlDataSource(DataConnectionParametersBase)Initializes a new instance of the DashboardSqlDataSource class with the specified connection parameters.
DashboardSqlDataSource(String, DataConnectionParametersBase)Initializes a new instance of the DashboardSqlDataSource class with the specified data source name and connection parameters.
DashboardSqlDataSource(String, String)Initializes a new instance of the DashboardSqlDataSource class with the specified data source and existing data connection names.
DashboardSqlDataSource(String)Initializes a new instance of the DashboardSqlDataSource class with the specified data source name.

Fields

NameDescription
KeepConnectionOpen staticObsolete. Use the ConnectionOptions.CloseConnection property instead. Inherited from SqlDataSource.

Properties

NameDescription
AllowCustomSqlQueries staticSpecifies whether a user can add custom SQL queries to fill the SqlDataSource. Inherited from SqlDataSource.
CalculatedFieldsProvides access to a data source’s calculated fields.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ComponentNameGets or sets the component name of the data source.
ConnectionProvides access to the data connection settings of the SqlDataSource. Inherited from SqlDataSource.
ConnectionNameSpecifies the name of a data connection in the App.config file. Inherited from SqlDataSource.
ConnectionOptionsProvides access to the data connection options of the SqlDataSource. Inherited from SqlDataSource.
ConnectionParametersSpecifies the data connection settings of the SqlDataSource. Inherited from SqlDataSource.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DataProcessingModeGets or sets the data processing mode for the current data source.
DBSchemaGets the schema of the connected SQL data source. Inherited from SqlDataSource.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisableCustomQueryValidation staticGets or sets whether the validation of custom SQL queries is performed. Inherited from SqlDataSource.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
IsConnectedGets whether the connection to a data store is established.
LockUIOnDataLoading staticGets or sets whether the user interface is locked when the data source loads data.
NameGets or sets the name of the data source.
QueriesProvides access to the collection of queries defined for the SqlDataSource. Inherited from SqlDataSource.
RelationsProvides access to the collection of master-detail relations of the SqlDataSource. Inherited from SqlDataSource.
RemoveCommentsBeforeExecution staticInherited from SqlDataSource.
ResultGets a collection of tables and their relations from the current SqlDataSource. Inherited from SqlDataSource.
SiteGets or sets the ISite of the Component. Inherited from Component.

Methods

NameDescription
BeginInit()For internal use.
ClearRows()Clears all data cached when filling the SqlDataSource, preserving the information about the original structure of tables, columns and data relations. Inherited from SqlDataSource.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
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()Validates and executes all valid queries available in the SqlDataSource.Queries collection. Inherited from SqlDataSource.
Fill(IEnumerable<IParameter>, String[])Validates and executes the specified queries with the required parameters. Inherited from SqlDataSource.
Fill(IEnumerable<IParameter>)Validates and executes all valid queries available in the SqlDataSource.Queries collection with the specified parameters. Inherited from SqlDataSource.
Fill(String[])Validates and executes the specified queries. Inherited from SqlDataSource.
FillAsync()Populates the SqlDataSource in an asynchronous manner. Inherited from SqlDataSource.
FillAsync(IEnumerable<IParameter>, String[], CancellationToken)Populates the SqlDataSource in an asynchronous manner, passes external parameters to the data source, and uses the cancellationToken parameter to send the cancellation signal. You can specify which queries to execute in order to populate the data source. Inherited from SqlDataSource.
FillAsync(IEnumerable<IParameter>, String[])Populates the SqlDataSource in an asynchronous manner and passes external parameters to the data source. You can specify which queries to execute in order to populate the data source. Inherited from SqlDataSource.
FillAsync(IEnumerable<IParameter>, CancellationToken)Populates the SqlDataSource in an asynchronous manner, passes external parameters to the data source, and uses the cancellationToken parameter to send the cancellation signal. Inherited from SqlDataSource.
FillAsync(IEnumerable<IParameter>)Populates the SqlDataSource in an asynchronous manner and passes external parameters to the data source. Inherited from SqlDataSource.
FillAsync(String[], CancellationToken)Populates the SqlDataSource in an asynchronous manner and uses the cancellationToken parameter to send the cancellation signal. You can specify which queries to execute in order to populate the data source. Inherited from SqlDataSource.
FillAsync(String[])Populates the SqlDataSource in an asynchronous manner. You can specify which queries to execute in order to populate the data source. Inherited from SqlDataSource.
FillAsync(CancellationToken)Populates the SqlDataSource in an asynchronous manner and uses the cancellationToken parameter to send the cancellation signal. Inherited from SqlDataSource.
GetDataProcessingMode(String)Gets the data processing mode for the specified query from the current data source.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type)Inherited from DataComponentBase.
GetType()Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
LoadFromXml(XElement)Loads the SQL data source schema definition from XML. Inherited from SqlDataSource.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
RebuildResultSchema()Validates and updates the result schema available on the client after query execution (it can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server. Inherited from SqlDataSource.
RebuildResultSchema(IEnumerable<IParameter>)Validates and updates the result schema available on the client after query execution with the specified parameters (the result schema can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server. Inherited from SqlDataSource.
RebuildResultSchema(Predicate<IEnumerable<SqlQuery>>, IEnumerable<IParameter>, IEnumerable<SqlQuery>)Validates and updates the result schema available on the client with the specified queries and parameters after confirming the execution of associated queries (the result schema can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server. Inherited from SqlDataSource.
RebuildResultSchema(Predicate<IEnumerable<SqlQuery>>, IEnumerable<IParameter>)Validates and updates the result schema available on the client with the specified parameters after confirming the execution of associated queries (the result schema can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server. Inherited from SqlDataSource.
RebuildResultSchema(Predicate<IEnumerable<SqlQuery>>)Validates and updates the result schema available on the client after confirming the execution of associated queries (the result schema can be accessed using the SqlDataSource.Result property). This command does not affect the actual database schema on the server. Inherited from SqlDataSource.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
SaveToXml()Saves the XML definition of the SQL data source schema. Inherited from SqlDataSource.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
BeforeLoadProviderCustomAssemblyOccurs on an attempt to load a provider custom assembly (the FireBirdConnectionParameters.ClientLibrary property value) by the Firebird data provider for a specific SQL data source. Inherited from SqlDataSource.
BeforeLoadProviderCustomAssemblyGlobal staticOccurs on an attempt to load a provider custom assembly (the FireBirdConnectionParameters.ClientLibrary property value) by the Firebird data provider for SQL data sources. Inherited from SqlDataSource.
ConfigureDataConnectionAllows you to customize connection settings before connecting to a database. Inherited from SqlDataSource.
ConnectionErrorFires after an attempt to establish a data connection has failed. Inherited from SqlDataSource.
CustomizeFilterExpressionAllows you to include WHERE clauses in SQL queries. Inherited from SqlDataSource.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ValidateCustomSqlQueryChecks the validity of the custom SQL query used to supply the data source with data. Inherited from SqlDataSource.
ValidateCustomSqlQueryGlobal staticProvides the capability to check the validity of the custom SQL query used to supply SQL data sources with data. Inherited from SqlDataSource.

See Also

DashboardSqlDataSource Class

DevExpress.DashboardCommon Namespace