DynamicField.DataField Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the name of the data field to bind the DynamicField object to.

Namespace:   System.Web.DynamicData
Assembly:  System.Web.DynamicData (in System.Web.DynamicData.dll)

Public Overridable Property DataField As String

Property Value

Type: System.String

The name of the data field that the DynamicField object is bound to.

Use the DataField property to specify the data field to bind to the DynamicField object. The data field can be the column name or, for foreign key columns, the relationship name.

By default, the specified data field is displayed by the DynamicField object using the field template that is associated with the field data type. You can change the field template that is rendered for the data field by setting the UIHint property. You can also format the displayed text by setting the DataFormatString property. If a field value is null, an empty string ("") is displayed for the value by default. To specify an alternate caption, set the NullDisplayText property.

Note   If you want to change the display and behavior of a data field globally, you must apply attributes to your data model instead of setting this in a particular instance of the DynamicField object. For more information, see ASP.NET Dynamic Data.

The OnFieldChanged method is called to raise a state change event when the DataField property is set.

The value of the DataField property is stored in view state.

.NET Framework
Available since 3.5
Return to top