Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

BaseDataBoundControl.OnDataBound Method

Raises the DataBound event.

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

'Declaration
Protected Overridable Sub OnDataBound ( _
	e As EventArgs _
)

Parameters

e
Type: System.EventArgs

An EventArgs object that contains the event data.

This method notifies a server control that any data binding logic associated with the control has completed.

Important noteImportant

The DataBind method is sealed on all controls derived from BaseDataBoundControl. Data-bound controls should override PerformDataBinding instead of the DataBind method to bind data. If DataBind is overridden, the OnDataBinding and OnDataBound events are raised out of order.

Raising an event invokes the event handler through a delegate. For more information, see Raising an Event.

The OnDataBound method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnDataBound in a derived class, be sure to call the base class’s OnDataBound method so that registered delegates receive the event.

The following code example demonstrates how the OnDataBound method is used to raise the DataBound event by a derived data-bound control class. After using the GetData and PerformDataBinding methods to bind data to the control, the data-bound control raises the DataBound event to signal that data binding is complete. This code example is part of a larger example provided for the DataBoundControl class.

    Protected Overrides Sub PerformSelect()

        ' Call OnDataBinding here if bound to a data source using the  
        ' DataSource property (instead of a DataSourceID) because the  
        ' data-binding statement is evaluated before the call to GetData. 
        If Not IsBoundUsingDataSourceID Then
            OnDataBinding(EventArgs.Empty)
        End If 

        ' The GetData method retrieves the DataSourceView object from the  
        ' IDataSource associated with the data-bound control.            
        GetData().Select(CreateDataSourceSelectArguments(), _
            AddressOf OnDataSourceViewSelectCallback)

        ' The PerformDataBinding method has completed.
        RequiresDataBinding = False
        MarkAsDataBound()

        ' Raise the DataBound event.
            OnDataBound(EventArgs.Empty)

    End Sub 'PerformSelect

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0
Show:
© 2015 Microsoft