Export (0) Print
Expand All

ObjectDataSourceView Class

Supports the ObjectDataSource control and provides an interface for data-bound controls to perform data operations with business and data objects.

System.Object
  System.Web.UI.DataSourceView
    System.Web.UI.WebControls.ObjectDataSourceView

Namespace:  System.Web.UI.WebControls
Assembly:  System.Web (in System.Web.dll)

public class ObjectDataSourceView : DataSourceView, 
	IStateManager

The ObjectDataSourceView type exposes the following members.

  NameDescription
Public methodObjectDataSourceViewInitializes a new instance of the ObjectDataSourceView class.
Top

  NameDescription
Public propertyCanDeleteGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports the delete operation. (Overrides DataSourceView.CanDelete.)
Public propertyCanInsertGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports the insert operation. (Overrides DataSourceView.CanInsert.)
Public propertyCanPageGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports paging through the retrieved data. (Overrides DataSourceView.CanPage.)
Public propertyCanRetrieveTotalRowCountGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports retrieving the total number of data rows, in addition to the set of data. (Overrides DataSourceView.CanRetrieveTotalRowCount.)
Public propertyCanSortGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports a sorted view on the underlying data source. (Overrides DataSourceView.CanSort.)
Public propertyCanUpdateGets a value indicating whether the ObjectDataSourceView object that is associated with the current ObjectDataSource control supports the update operation. (Overrides DataSourceView.CanUpdate.)
Public propertyConflictDetectionGets or sets a value that determines how the ObjectDataSource control performs updates and deletes when data in a row in the underlying data storage changes during the time of the operation.
Public propertyConvertNullToDBNullGets or sets a value indicating whether Parameter values that are passed to an update, insert, or delete operation are automatically converted from null to the Value value.
Public propertyDataObjectTypeNameGets or sets the name of a class that the ObjectDataSource control uses for a parameter in a data operation. The ObjectDataSource control uses the specified class instead of the Parameter objects that are in the various parameters collections.
Public propertyDeleteMethodGets or sets the name of the method or function that the ObjectDataSourceView object invokes to delete data.
Public propertyDeleteParametersGets the parameters collection that contains the parameters that are used by the DeleteMethod method.
Public propertyEnablePagingGets or sets a value indicating whether the data source control supports paging through the set of data that it retrieves.
Protected propertyEventsGets a list of event-handler delegates for the data source view. (Inherited from DataSourceView.)
Public propertyFilterExpressionGets or sets a filtering expression that is applied when the business object method that is identified by the SelectMethod property is called.
Public propertyFilterParametersGets a collection of parameters that are associated with any parameter placeholders that are in the FilterExpression string.
Public propertyInsertMethodGets or sets the name of the method or function that the ObjectDataSourceView object invokes to insert data.
Public propertyInsertParametersGets the parameters collection that contains the parameters that are used by the InsertMethod method.
Protected propertyIsTrackingViewStateGets a value indicating whether the ObjectDataSourceView object is saving changes to its view state.
Public propertyMaximumRowsParameterNameGets 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 propertyNameGets the name of the data source view. (Inherited from DataSourceView.)
Public propertyOldValuesParameterFormatStringGets 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 propertyParsingCultureGets a or sets a value that indicates what culture information is used when converting string values to actual property types in order to construct an object of the type indicated by DataObjectTypeName.
Public propertySelectCountMethodGets or sets the name of the method or function that the ObjectDataSourceView control invokes to retrieve a row count.
Public propertySelectMethodGets or sets the name of the method or function that the ObjectDataSourceView control invokes to retrieve data.
Public propertySelectParametersGets the parameters collection containing the parameters that are used by the SelectMethod method.
Public propertySortParameterNameGets or sets the name of the data retrieval method parameter that is used to specify a sort expression for data source sorting support.
Public propertyStartRowIndexParameterNameGets 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 propertyTypeNameGets or sets the name of the class that the ObjectDataSource control represents.
Public propertyUpdateMethodGets or sets the name of the method or function that the ObjectDataSourceView object invokes to update data.
Public propertyUpdateParametersGets the parameters collection containing the parameters that are used by the UpdateMethod method.
Top

  NameDescription
Public methodCanExecuteDetermines whether the specified command can be executed. (Inherited from DataSourceView.)
Public methodDelete(IDictionary, IDictionary)Performs a delete operation by calling the business object method that is identified by the DeleteMethod property using the specified keys and oldValues collections.
Public methodDelete(IDictionary, IDictionary, DataSourceViewOperationCallback)Performs an asynchronous delete operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodExecuteCommand(String, IDictionary, IDictionary)Executes the specified command. (Inherited from DataSourceView.)
Public methodExecuteCommand(String, IDictionary, IDictionary, DataSourceViewOperationCallback)Executes the specified command. (Inherited from DataSourceView.)
Protected methodExecuteDeletePerforms a delete operation using the DeleteMethod method and the specified keys and oldValues collection. (Overrides DataSourceView.ExecuteDelete(IDictionary, IDictionary).)
Protected methodExecuteInsertPerforms an insert operation by calling the business object method that is identified by the InsertMethod property using the specified values collection. (Overrides DataSourceView.ExecuteInsert(IDictionary).)
Protected methodExecuteSelectRetrieves data from the object that is identified by the TypeName property by calling the method that is identified by the SelectMethod property and passing any values in the SelectParameters collection. (Overrides DataSourceView.ExecuteSelect(DataSourceSelectArguments).)
Protected methodExecuteUpdatePerforms an update operation by calling the method that is identified by the UpdateMethod property and using any parameters that are supplied in the keys, values, or oldValues collections. (Overrides DataSourceView.ExecuteUpdate(IDictionary, IDictionary, IDictionary).)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInsert(IDictionary)Performs an insert operation by calling the business object method that is identified by the InsertMethod property using the specified values collection.
Public methodInsert(IDictionary, DataSourceViewOperationCallback)Performs an asynchronous insert operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Protected methodLoadViewStateRestores previously saved view state for the data source view.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnDataSourceViewChangedRaises the DataSourceViewChanged event. (Inherited from DataSourceView.)
Protected methodOnDeletedRaises the Deleted event after the ObjectDataSourceView object has completed a delete operation.
Protected methodOnDeletingRaises the Deleting event before the ObjectDataSourceView object attempts a delete operation.
Protected methodOnFilteringRaises the Filtering event before the ObjectDataSourceView object attempts a filtering operation.
Protected methodOnInsertedRaises the Inserted event after the ObjectDataSourceView object has completed an insert operation.
Protected methodOnInsertingRaises the Inserting event before the ObjectDataSourceView object attempts an insert operation.
Protected methodOnObjectCreatedRaises the ObjectCreated event after the ObjectDataSourceView creates an instance of the object that is identified by the TypeName property.
Protected methodOnObjectCreatingRaises the ObjectCreating event before the ObjectDataSourceView object creates an instance of a business object to perform a data operation.
Protected methodOnObjectDisposingRaises the ObjectDisposing event before the ObjectDataSourceView object discards an instantiated type.
Protected methodOnSelectedRaises the Selected event after the ObjectDataSourceView object has completed a data retrieval operation.
Protected methodOnSelectingRaises the Selecting event before the ObjectDataSourceView object attempts a data retrieval operation.
Protected methodOnUpdatedRaises the Updated event after the ObjectDataSourceView object has completed an update operation.
Protected methodOnUpdatingRaises the Updating event before the ObjectDataSourceView object attempts an update operation.
Protected methodRaiseUnsupportedCapabilityErrorCalled by the RaiseUnsupportedCapabilitiesError method to compare the capabilities requested for an ExecuteSelect operation against those that the view supports. (Inherited from DataSourceView.)
Protected methodSaveViewStateSaves the changes to the view state for the ObjectDataSourceView object since the time when the page was posted back to the server.
Public methodSelect(DataSourceSelectArguments)Retrieves data from the object that is identified by the TypeName property by calling the method that is identified by the SelectMethod property and passing any values in the SelectParameters collection.
Public methodSelect(DataSourceSelectArguments, DataSourceViewSelectCallback)Gets a list of data asynchronously from the underlying data storage. (Inherited from DataSourceView.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateCauses the ObjectDataSourceView object to track changes to its view state so that the changes can be stored in the ViewState object for the control and persisted across requests for the same page.
Public methodUpdate(IDictionary, IDictionary, IDictionary)Performs an update operation by calling the method that is identified by the UpdateMethod property and using any parameters that are supplied in the keys, values, or oldValues collections.
Public methodUpdate(IDictionary, IDictionary, IDictionary, DataSourceViewOperationCallback)Performs an asynchronous update operation on the list of data that the DataSourceView object represents. (Inherited from DataSourceView.)
Top

  NameDescription
Public eventDataSourceViewChangedOccurs when the data source view has changed. (Inherited from DataSourceView.)
Public eventDeletedOccurs when a Delete operation has completed.
Public eventDeletingOccurs before a Delete operation.
Public eventFilteringOccurs before a filter operation.
Public eventInsertedOccurs when an Insert operation has completed.
Public eventInsertingOccurs before an Insert operation.
Public eventObjectCreatedOccurs after the ObjectDataSourceView object creates an instance of the type that is identified by the TypeName property.
Public eventObjectCreatingOccurs before the ObjectDataSourceView object creates an instance of the type that is identified by the TypeName property.
Public eventObjectDisposingOccurs when the ObjectDataSourceView object discards an instance of an object that it has created.
Public eventSelectedOccurs when a data retrieval operation has completed.
Public eventSelectingOccurs before a data retrieval operation.
Public eventUpdatedOccurs when an Update operation has completed.
Public eventUpdatingOccurs before an Update operation.
Top

  NameDescription
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateFor a description of this member, see IsTrackingViewState.
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. For a description of this member, see IStateManager.LoadViewState.
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. For a description of this member, see IStateManager.SaveViewState.
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. For a description of this member, see IStateManager.TrackViewState.
Top

The ObjectDataSourceView class is intended primarily to be used by data-bound controls, and not as a programmable object in page code.

The ObjectDataSourceView class implements the data functionality for the ObjectDataSource control, including the Select, Update, Delete, and Insert operations, sorting, filtering, and management of settings kept in view state.

A ObjectDataSourceView object is created for each instance of the ObjectDataSource class at run time. Calls to data operations of the instance of the ObjectDataSource class are handled by the instance of the ObjectDataSourceView object. Page developers do not access the instance of the ObjectDataSourceView class directly. Control developers can create custom data controls by extending the ObjectDataSource and ObjectDataSourceView classes.

The ObjectDataSourceView class performs data operations by calling methods on business or data objects using reflection. At run time, the ObjectDataSource control creates an instance of the type that is identified by the TypeName property, and then calls the appropriate method for the data operation. The instantiated object is not cached in memory by the ObjectDataSourceView. The object is created and destroyed for every data method call. If the method is static (Shared in Visual Basic), an instance is not created but the data operation method is still called.

The ObjectDataSourceView is not directly exposed to page developers by the ObjectDataSource control. Instead, the properties and methods of the ObjectDataSourceView are accessed through the ObjectDataSource. For example, the DeleteMethod of ObjectDataSourceView property is set by setting the DeleteMethod property of the ObjectDataSource.

Retrieving Data

The most basic operation that a data source view performs is data retrieval from the underlying data storage using the Select method, which retrieves an IEnumerable collection of data items. The following data retrieval methods, properties, and events are implemented by the ObjectDataSourceView object and exposed directly by its ObjectDataSource control to page developers and other callers:

Updating Data

The ObjectDataSourceView object supports data updates by calling a business or data object method that is identified by the UpdateMethod property. Data-bound controls that automatically perform updates, such as the GridView and DetailsView controls, pass their parameters in an IOrderedDictionary interface to the ObjectDataSourceView and the view object merges these parameters with any parameters that are found in the UpdateParameters collection.

The following update methods, properties, and events are implemented by the ObjectDataSourceView and exposed directly by its ObjectDataSource control to page developers and other callers:

Inserting Data

The ObjectDataSourceView object supports inserting new rows of data by calling a business or data object method that is identified by the InsertMethod property. Data-bound controls that automatically perform inserts, such as the GridView and DetailsView, pass their parameters in an IOrderedDictionary interface to the ObjectDataSourceView and the view object merges these parameters with any parameters that are found in the InsertParameters collection.

The following insert methods, properties, and events are implemented by the ObjectDataSourceView and exposed directly by its ObjectDataSource control to page developers and other callers:

Deleting Data

The ObjectDataSourceView object supports deleting data by calling a business or data object method that is identified by the DeleteMethod property. Data-bound controls that automatically perform deletes, such as the GridView and DetailsView, pass their parameters in an IOrderedDictionary interface to the ObjectDataSourceView and the view object merges these parameters with any parameters that are found in the DeleteParameters collection. The following delete methods, properties, and events are implemented by the ObjectDataSourceView and exposed directly by its ObjectDataSource control to page developers and other callers:

Filtering and Sorting Data

Data retrieval is more powerful when you can filter the data dynamically. Filtering is supported only by the ObjectDataSource control if the Select method returns a DataTable or DataSet object. You can use the FilterExpression and FilterParameters properties to apply dynamic filtering to data retrieval. These properties are implemented by the ObjectDataSourceView object and exposed directly by its ObjectDataSource control to data-bound controls and other callers.

You can sort the data that you retrieve with the ObjectDataSource by ordering the data in memory after it is retrieved. Sorting is supported only by the ObjectDataSource control if the Select method returns a DataTable or DataSet. The CanSort property always returns true, because the ObjectDataSourceView cannot determine what type is returned by the Select method without calling the method. The SortExpression property syntax is the same as for a DataView.Sort property.

Tracking View State

The ObjectDataSourceView implements the IStateManager interface and uses view state to track its state across page requests. Implementation of the LoadViewState, SaveViewState, and TrackViewState methods are provided to enable view state tracking for the control. For more information, see ASP.NET State Management Overview.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft