Skip to end of metadata
Go to start of metadata

Represents a business object that provides data to data-bound controls.

Definition

public class ISDataSourceTable : NamedObjectBase, IDataSourceTable

Summary

The following table summarizes the members exposed in this class.

Public Constructors

ISDataSourceTable Constructor() Initializes a new instance of ISDataSourceTable class.

Protected Constructors

ISDataSourceTable Constructor(SerializationInfo, StreamingContext) Initializes a new instance of the ISDataSourceTable class.

Public Properties

CacheDuration Gets or sets the length of time, in seconds, that the data source control caches data that is retrieved by the SelectMethod method.
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.
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.
CachePriority Gets or sets the relative priority of items stored in the Cache object.
CacheScope Gets or sets the scope of the cached data.
CacheServerConnection Get or sets the cache's file server connection string.
CacheStorage Gets or sets the storage of the cached data.
CancelSelectOnNullParameter
ConflictDetection Gets or sets a value that determines whether or not just the new values are passed to the Update method or both the old and new values are passed to the Update method.
Context Gets the HttpContext object associated with the server control for the current Web request.
Control Gets the ISDataSource control associated with this ISDataSourceTable
ConvertNullToDBNull Gets or sets a value indicating whether the Parameter values that are passed to an update, insert, or delete operation are automatically converted from a null reference (Nothing in Visual Basic) to the Value value by the ISDataSource control.
DataObjectTypeName Gets or sets the name of a class that the ISDataSourceTable uses for a parameter in an update, insert, or delete data operation, instead of passing individual values from the data-bound control.
DeleteMethod Gets or sets the name of the method or function that the ISDataSourceTable invokes to delete data.
DeleteParameters Gets the parameters collection that contains the parameters that are used by the DeleteMethod method.
EnableCaching Gets or sets a value indicating whether the ISDataSource control has data caching enabled.
EnablePaging Gets or sets a value indicating whether the ISDataSourceTable supports paging through the set of data that it retrieves.
FilterExpression Gets or sets a filtering expression that is applied when the method that is specified by the SelectMethod property is called.
FilterParameters Gets a collection of parameters that are associated with any parameter placeholders in the FilterExpression string.
InsertMethod Gets or sets the name of the method or function that the ISDataSourceTable invokes to insert data.
InsertParameters Gets the parameters collection that contains the parameters that are used by the InsertMethod method.
InternalFilterExpression
InternalSortExpression
MaximumRowsParameterName Gets or sets the name of the data retrieval method parameter that is used to indicate the number of records to retrieve for data source paging support.
OldValuesParameterFormatString Gets or sets a format string to apply to the names of the parameters for original values that are passed to the Delete or Update methods.
ParameterOption Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the behavior how the values is passed from Intersoft data-bound controls for Update, Insert and Delete operations.
SelectChildRowMethod Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve child rows data. Used for performing load on demand in Hierachical WebGrid 5.0+ .
SelectCountMethod Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve a row count.
SelectMethod Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve data.
SelectParameters Gets the parameters collection that contains the parameters that are used by the SelectMethod method.
SelectSelfReferenceRowMethod Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve self reference rows data. Used for performing load on demand in SelfReferenced WebGrid 5.0+ .
SortExpression Gets or sets a sorting expression that is applied when the method that is specified by the SelectMethod property is called.
SortParameterName Gets or sets the name of the business object that the SelectMethod parameter used to specify a sort expression for data source sorting support.
StartRowIndexParameterName Gets or sets the name of the data retrieval method parameter that is used to indicate the integer index of the first record to retrieve from the results set for data source paging support.
StoreCachePerPage Gets or sets a value indicating whether the ISDataSource control will store the cached data separately for each page.
TableName Gets or sets a unique value that indicates the ISDataSourceTable's Name
TotalRowCount
TypeName Gets or sets the name of the class that the ISDataSourceTable object represents.
UpdateMethod Gets or sets the name of the method or function that the ISDataSourceTable invokes to update data.
UpdateParameters Gets the parameters collection that contains the parameters that are used by the method that is specified by the UpdateMethod property.
UseCachedDataOnFirstLoad Gets or sets a value indicating whether the ISDataSource control will use cached data on first load when caching is enabled.
View Gets the ISDataSourceView object associated with this ISDataSourceTable

Public Methods

ClearCache() Clear all cache related to this table
ClearCacheAndData()
CopyFrom(object)
Delete() Performs a delete operation by calling the method that is identified by the DeleteMethod property with any parameters that are in the DeleteParameters collection.
GetTableSchema(IEnumerable) Gets the schema for this datasource table.
GetView() Gets the ISDataSourceView associated with the ISDataSourceTable.
Insert() Performs an insert operation by calling the method that is identified by the InsertMethod property and any parameters in the InsertParameters collection.
IsCachingEnabled()
Select() Retrieves data from the underlying data storage by calling the method that is identified by the SelectMethod property with the parameters in the SelectParameters collection.
Select(DataSourceSelectArguments) Retrieves data from the underlying data storage by calling the method that is identified by the SelectMethod property with the parameters in the SelectParameters collection.
Update() Performs an update operation by calling the method that is identified by the UpdateMethod property and any parameters that are in the UpdateParameters collection.

Public Constructors

public ISDataSourceTable()

Initializes a new instance of ISDataSourceTable class.

Protected Constructors

protected ISDataSourceTable(SerializationInfo info, StreamingContext context)

Initializes a new instance of the ISDataSourceTable class.

Parameters

info Serialization info
context Streaming context

Public Properties

public int CacheDuration { get; set; }

Gets or sets the length of time, in seconds, that the data source control caches data that is retrieved by the SelectMethod method.

public CacheExpirationPolicy CacheExpirationPolicy { get; set; }

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.

public string CacheKeyDependency { get; set; }

Gets or sets a user-defined key dependency that is linked to all data cache objects that are created by the data source control.

public CachePriority CachePriority { get; set; }

Gets or sets the relative priority of items stored in the Cache object.

public CacheScope CacheScope { get; set; }

Gets or sets the scope of the cached data.

public string CacheServerConnection { get; set; }

Get or sets the cache's file server connection string.

public CacheStorage CacheStorage { get; set; }

Gets or sets the storage of the cached data.

public CancelSelectOnNullParameter CancelSelectOnNullParameter { get; set; }

public ConflictOptions ConflictDetection { get; set; }

Gets or sets a value that determines whether or not just the new values are passed to the Update method or both the old and new values are passed to the Update method.

public HttpContext Context { get; set; }

Gets the HttpContext object associated with the server control for the current Web request.

public ISDataSource Control { get; set; }

Gets the ISDataSource control associated with this ISDataSourceTable

public NullToDBNull ConvertNullToDBNull { get; set; }

Gets or sets a value indicating whether the Parameter values that are passed to an update, insert, or delete operation are automatically converted from a null reference (Nothing in Visual Basic) to the Value value by the ISDataSource control.

public string DataObjectTypeName { get; set; }

Gets or sets the name of a class that the ISDataSourceTable uses for a parameter in an update, insert, or delete data operation, instead of passing individual values from the data-bound control.

public string DeleteMethod { get; set; }

Gets or sets the name of the method or function that the ISDataSourceTable invokes to delete data.

public ParameterCollection DeleteParameters { get; }

Gets the parameters collection that contains the parameters that are used by the DeleteMethod method.

public CacheEnabled EnableCaching { get; set; }

Gets or sets a value indicating whether the ISDataSource control has data caching enabled.

public bool EnablePaging { get; set; }

Gets or sets a value indicating whether the ISDataSourceTable supports paging through the set of data that it retrieves.

public string FilterExpression { get; set; }

Gets or sets a filtering expression that is applied when the method that is specified by the SelectMethod property is called.

public ParameterCollection FilterParameters { get; }

Gets a collection of parameters that are associated with any parameter placeholders in the FilterExpression string.

public string InsertMethod { get; set; }

Gets or sets the name of the method or function that the ISDataSourceTable invokes to insert data.

public ParameterCollection InsertParameters { get; }

Gets the parameters collection that contains the parameters that are used by the InsertMethod method.

public string InternalFilterExpression { get; set; }

public string InternalSortExpression { get; set; }

public string MaximumRowsParameterName { get; set; }

Gets or sets the name of the data retrieval method parameter that is used to indicate the number of records to retrieve for data source paging support.

public string OldValuesParameterFormatString { get; set; }

Gets or sets a format string to apply to the names of the parameters for original values that are passed to the Delete or Update methods.

public ParameterOptions ParameterOption { get; set; }

Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the behavior how the values is passed from Intersoft data-bound controls for Update, Insert and Delete operations.

public string SelectChildRowMethod { get; set; }

Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve child rows data. Used for performing load on demand in Hierachical WebGrid 5.0+ .

public string SelectCountMethod { get; set; }

Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve a row count.

public string SelectMethod { get; set; }

Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve data.

public ParameterCollection SelectParameters { get; }

Gets the parameters collection that contains the parameters that are used by the SelectMethod method.

public string SelectSelfReferenceRowMethod { get; set; }

Note : This feature only useable when ISDataSource is bound to Intersoft data-bound controls. Gets or sets the name of the method or function that the ISDataSourceTable invokes to retrieve self reference rows data. Used for performing load on demand in SelfReferenced WebGrid 5.0+ .

public string SortExpression { get; set; }

Gets or sets a sorting expression that is applied when the method that is specified by the SelectMethod property is called.

public string SortParameterName { get; set; }

Gets or sets the name of the business object that the SelectMethod parameter used to specify a sort expression for data source sorting support.

public string StartRowIndexParameterName { get; set; }

Gets or sets the name of the data retrieval method parameter that is used to indicate the integer index of the first record to retrieve from the results set for data source paging support.

public StoreCachePerPage StoreCachePerPage { get; set; }

Gets or sets a value indicating whether the ISDataSource control will store the cached data separately for each page.

public string TableName { get; set; }

Gets or sets a unique value that indicates the ISDataSourceTable's Name

public int TotalRowCount { get; }

public string TypeName { get; set; }

Gets or sets the name of the class that the ISDataSourceTable object represents.

public string UpdateMethod { get; set; }

Gets or sets the name of the method or function that the ISDataSourceTable invokes to update data.

public ParameterCollection UpdateParameters { get; }

Gets the parameters collection that contains the parameters that are used by the method that is specified by the UpdateMethod property.

public UseCachedDataOnFirstLoad UseCachedDataOnFirstLoad { get; set; }

Gets or sets a value indicating whether the ISDataSource control will use cached data on first load when caching is enabled.

public ISDataSourceView View { get; set; }

Gets the ISDataSourceView object associated with this ISDataSourceTable

Public Methods

public void ClearCache()

Clear all cache related to this table

public void ClearCacheAndData()

public void CopyFrom(object obj)

Parameters

obj

public int Delete()

Performs a delete operation by calling the method that is identified by the DeleteMethod property with any parameters that are in the DeleteParameters collection.

Return Types

A value that represents the number of rows deleted from the underlying data storage, if the AffectedRows property of the ISDataSourceStatusEventArgs is set in the Deleted event; otherwise, -1.

public IDataSourceTableSchema GetTableSchema(IEnumerable dataSource)

Gets the schema for this datasource table.

Parameters

dataSource The datasource which schema to be retrieved.

Return Types

An object instance that implement IDataSourceTableSchema interface.

public ISDataSourceView GetView()

Gets the ISDataSourceView associated with the ISDataSourceTable.

Return Types

Returns the ISDataSourceView associated with the ISDataSourceTable.

public int Insert()

Performs an insert operation by calling the method that is identified by the InsertMethod property and any parameters in the InsertParameters collection.

Return Types

A value that represents the number of rows inserted into the underlying data storage.

public bool IsCachingEnabled()

public IEnumerable Select()

Retrieves data from the underlying data storage by calling the method that is identified by the SelectMethod property with the parameters in the SelectParameters collection.

Return Types

An IEnumerable list of data rows.

public IEnumerable Select(DataSourceSelectArguments args)

Retrieves data from the underlying data storage by calling the method that is identified by the SelectMethod property with the parameters in the SelectParameters collection.

Parameters

args A DataSourceSelectArguments used to request operations on the data beyond basic data retrieval.

Return Types

An IEnumerable list of data rows.

public int Update()

Performs an update operation by calling the method that is identified by the UpdateMethod property and any parameters that are in the UpdateParameters collection.

Return Types

A value that represents the number of rows updated in the underlying data storage.
  • No labels