smartDBforms.NET API Reference

SmartDataSource Members

SmartDataSource overview

Public Instance Constructors

SmartDataSource Constructor Initializes a new instance of the SmartDataSource class.

Public Instance Properties

CacheDuration Gets or sets the length of time, in seconds, for which the retrieved data will stay in cache before discarding.
CacheExpirationPolicy Gets or sets the cache expiration behavior that, when combined with the duration, describes the behavior of the cache that the data source control uses. The default value is Absolute
CacheKeyDependency Gets or sets a user-defined key dependency that is linked to all data cache objects that are created by the data source control. In this way all cache objects that reference this additional dependency will explicitly expire when the key is expires.
CancelSelectOnNullParameter Gets or sets a value indicating whether the data retrieval operation is canceled when any parameter that is contained in the SelectParameters collection evaluates to null.
ConflictDetection Gets or sets the value indicating how update and delete operation are performed when data in a row in the underlying database changes during the time of the operation. The default value is OverwriteChanges.
ConnectionString Gets or sets the .NET Framework data provider–specific connection string that is used to connect to an underlying database. The default is an empty string ("")
DataKeyNames Explicitly sets the primary key columns. If you specify custom primary key columns they will override the database primary key definitions.
DeleteCommand Gets or sets the SQL string that is used to delete data from the underlying database. The parameters of the sql command are represented by the DeleteParameters collection.
DeleteParameters Gets the parameters collection that contains the parameters that are used by the DeleteCommand.
EnableCaching Gets or sets a value indicating whether the data caching is enabled.
ExtractFKRelations Specifies if foreign key relation meta information to be extracted. The default value is true.
FilterExpression Gets or sets a filtering expression that is applied during selection to the retrieved data. This expression can have parameters which are represented by the FilterParameters collection. The parameters are represented by format string placeholders (for example, "{0}"). For more information see SqlDataSource.FilterExpression.
For query syntax details see DataColumn.Expression Property.
FilterParameters Gets a collection of parameters that are associated with any parameter placeholders that are in the FilterExpression string.
InsertCommand Gets or sets the SQL string that is used to insert data in the underlying database. The parameters of the sql command are represented by the InsertParameters collection.
InsertParameters Gets the parameters collection that contains the parameters that are used by the InsertCommand.
MonitorParameters Gets or sets a value indicating whether the SelectParameters and FilterParameters will be automatically monitored for changes. If some of the parameters changes the DataSourceViewChanged is fired. In this way the controls that use this data source will be notified of the change and will automatically rebind.
OldValuesParameterFormatString Gets or sets a format string to apply to the names of any parameters that are passed to update and delete commands. This is used only when the ConflictDetection property is set to CompareAllValues
ProviderName Gets or sets the name of the .NET Framework data provider that is used to connect to an underlying data source. This should be set together with ConnectionString and should represent the provider that is able to parse the connection string The default is the data provider for Microsoft SQL Server.
SelectCommand Gets or sets the SQL string that is used to retrieve data from the underlying database. The parameters of the sql command are represented by the SelectParameters collection.
SelectParameters Gets the parameters collection that contains the parameters that are used by the SelectCommand.
UpdateCommand Gets or sets the SQL string that is used to update data in the underlying database. The parameters of the sql command are represented by the UpdateParameters collection.
UpdateParameters Gets the parameters collection that contains the parameters that are used by the UpdateCommand.

Public Instance Methods

DataSourceChanged Triggers the DataSourceChanged event.
DeleteOverloaded. Performs an delete operation using any parameters that are in the DeleteParameters collection and the values that are passed in the input parameters.
InsertOverloaded. Performs an insert operation using any parameters that are in the InsertParameters collection and the values that are passed in the input parameters.
SelectRetrieves data from the underlying database using the SelectCommand SQL string and any parameters that are in the SelectParameters collection.
UpdateOverloaded. Performs an update operation using any parameters that are in the UpdateParameters collection and the values that are passed in the input parameters.

Public Instance Events

ColumnInfo Occurs during data retrieval, when meta information for a data column is being retrieved.
Deleted Occurs when a delete operation has completed.
Deleting Occurs before a delete operation.
Filtering Occurs before a filter operation.
FKInfo Occurs during data retrieval, when meta information for a foreign-key is being retrieved.
Inserted Occurs when an insert operation has completed.
Inserting Occurs before an insert operation.
ParentTableInfo Occurs during data retrieval, when meta information for a parent foreign-key table is being retrieved.
Selected Occurs when a data retrieval operation has completed.
Selecting Occurs before a data retrieval operation.
Updated Occurs when an update operation has completed.
Updating Occurs before an update operation.

See Also

SmartDataSource Class | Adillis.SmartDBForms.DataSource Namespace