BaseDataBoundControl.OnDataPropertyChanged Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Rebinds the data-bound control to its data after one of the base data source identification properties changes.

protected:
 virtual void OnDataPropertyChanged();

protected virtual void OnDataPropertyChanged();

abstract member OnDataPropertyChanged : unit -> unit
override this.OnDataPropertyChanged : unit -> unit

Protected Overridable Sub OnDataPropertyChanged ()

Exceptions

HttpException

An attempt was made to change the property value during the data-binding phase of the control.

Examples

The following code example shows a property that belongs to a derived data-bound control class. The example demonstrates how a data-bound control can call the OnDataPropertyChanged method if a property that identifies a data source is changed after the data-bound control is initialized. This code example is part of a larger example provided for the DataBoundControl class.

public string DataTextField {
    get {
        object o = ViewState["DataTextField"];
        return((o == null) ? string.Empty : (string)o);
    }
    set {
        ViewState["DataTextField"] = value;
        if (Initialized) {
            OnDataPropertyChanged();
        }
    }
}

Public Property DataTextField() As String
    Get
        Dim o As Object = ViewState("DataTextField")
        If o Is Nothing Then
            Return String.Empty
        Else
            Return CStr(o)
        End If
    End Get
    Set(ByVal value As String)
        ViewState("DataTextField") = value
        If (Initialized) Then
            OnDataPropertyChanged()
        End If
    End Set
End Property

Remarks

The OnDataPropertyChanged method is called when the DataSource, DataSourceID, or DataMember property value changes any time after the page's PreRender event has occurred.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via