DisplayFormatAttribute.ApplyFormatInEditMode Property

Reference

Definition

Namespace:: System.ComponentModel.DataAnnotations

Assemblies:: System.ComponentModel.Annotations.dll, System.ComponentModel.DataAnnotations.dll

Assembly:: System.ComponentModel.Annotations.dll

Assembly:: System.ComponentModel.DataAnnotations.dll

Package:: System.ComponentModel.Annotations v5.0.0

Source:: DisplayFormatAttribute.cs

Source:: DisplayFormatAttribute.cs

Source:: DisplayFormatAttribute.cs

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.

Gets or sets a value that indicates whether the formatting string that is specified by the DataFormatString property is applied to the field value when the data field is in edit mode.

public:
 property bool ApplyFormatInEditMode { bool get(); void set(bool value); };

public bool ApplyFormatInEditMode { get; set; }

member this.ApplyFormatInEditMode : bool with get, set

Public Property ApplyFormatInEditMode As Boolean

Property Value

Boolean

true if the formatting string applies to the field value in edit mode; otherwise, false. The default is false.

Examples

The following example shows how to use the ApplyFormatInEditMode property to set the display format for date information when the data field is in edit mode. The data field format to use for the data field is specified by setting the DataFormatString property.

// Display date data field in the short format 11/12/08.
// Also, apply format in edit mode.
[DisplayFormat(ApplyFormatInEditMode=true, DataFormatString = "{0:d}")]
public object SellStartDate;

' Display date data field in the short format such as 11/12/08.
' Also, apply format in edit mode.
<DisplayFormat(ApplyFormatInEditMode:=True, DataFormatString:="{0:d}")> _
Public SellStartDate As Object

Remarks

By default, the formatting string that is specified by the DataFormatString property is applied to field values only when the data-bound control is in read-only mode.

Applies to

Product	Versions
.NET	Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	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
.NET Standard	2.0 (package-provided), 2.1 (package-provided)
UWP	10.0

Share via