DisplayFormatAttribute.DataFormatString Свойство

Определение

Пространство имен:

System.ComponentModel.DataAnnotations

Сборка:

System.ComponentModel.Annotations.dll

Исходный код:

DisplayFormatAttribute.cs

Возвращает или задает формат отображения для значения поля.

public:
 property System::String ^ DataFormatString { System::String ^ get(); void set(System::String ^ value); };

public string? DataFormatString { get; set; }

member this.DataFormatString : string with get, set

Public Property DataFormatString As String

Значение свойства

String

Строка форматирования, указывающая формат отображения для значения поля данных. Значение по умолчанию — пустая строка (""), указывающая, что к значению поля не применяется специальное форматирование.

Примеры

В следующих примерах показано, как использовать DataFormatString свойство для задания формата отображения полей данных. Первый пример задает формат отображения для поля данных типа валюты. Второй пример задает формат отображения для поля данных типа даты.

// Display currency data field in the format $1,345.50.
[DisplayFormat(DataFormatString="{0:C}")]
public object StandardCost;

' Display currency data field in the format such as $1,345.50.
<DisplayFormat(DataFormatString:="{0:C}")> _
Public StandardCost As Object

// 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

Комментарии

DataFormatString Используйте свойство, чтобы указать пользовательский формат отображения для значений, отображаемых в объектеDynamicField. DataFormatString Если свойство не задано, значение поля отображается без специального форматирования. Дополнительные сведения см. в статье Типы форматирования в .NET.

Замечание

DynamicField.HtmlEncode Если свойство равноtrue, значение поля закодировано в его строковое представление перед применением строки форматирования. Для некоторых объектов, таких как даты, может потребоваться управлять отображением объекта строкой форматирования. В этих случаях необходимо задать DynamicField.HtmlEncode для falseсвойства значение .

По умолчанию строка форматирования применяется к значению поля только в том случае, если элемент управления с привязкой к данным, содержащий DynamicField объект, находится в режиме только для чтения. Чтобы применить строку форматирования к значениям полей, если они находятся в режиме редактирования, задайте ApplyFormatInEditMode для свойства значение true.

Строка форматирования может быть любой литеральной строкой и обычно включает заполнитель для значения поля. Например, в строке форматирования "Значение элемента" {0}значение поля заменяет {0} заполнитель при отображении строки в объекте DynamicField . Оставшаяся часть строки форматирования отображается в виде литерального текста.

Замечание

Если строка форматирования не включает заполнитель, значение поля из источника данных не включается в окончательный отображаемый текст.

См. также раздел

• Типы форматирования в .NET