DynamicField.DataFormatString 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 string that specifies the display format for the value of the data field.

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

abstract DataFormatString : string with get, set
override DataFormatString : string with get, set

Property Value

Type: System.String

A formatting string that specifies the display format for the value of the data field. The default is an empty string (""), which indicates that no special formatting is applied to the value.

Use the DataFormatString property to specify a custom display format for the values displayed in the DynamicField object. If the DataFormatString property is not set, the field value is displayed without any special formatting.

By default, the formatting string is applied to the field value only when the data-bound control that contains the DynamicField object is in read-only mode. To apply the formatting string to the field value while in edit mode, set the ApplyFormatInEditMode property to true.

The display format that you specify using the DataFormatString property is specific to this instance of the DynamicField class. You can also change the display format for a data field across the entire application by applying the DisplayFormatAttribute to your data model and setting the DisplayFormatAttribute.DataFormatString named parameter in the constructor. For more information, see ASP.NET Dynamic Data.

.NET Framework
Available since 3.5
Return to top