DisplayFormatAttribute.DataFormatString Propriedade

Definição

Namespace:

System.ComponentModel.DataAnnotations

Assembly:

System.ComponentModel.Annotations.dll

Origem:

DisplayFormatAttribute.cs

Obtém ou define o formato de exibição do valor do campo.

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

Valor da propriedade

String

Uma cadeia de formatação que especifica o formato de exibição para o valor do campo de dados. O padrão é uma cadeia de caracteres vazia (""), o que indica que nenhuma formatação especial é aplicada ao valor do campo.

Exemplos

Os exemplos a seguir mostram como usar a DataFormatString propriedade para definir o formato de exibição dos campos de dados. O primeiro exemplo define o formato de exibição para um campo de dados de tipo de moeda. O segundo exemplo define o formato de exibição para um campo de dados de tipo de data.

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

Comentários

Use a DataFormatString propriedade para especificar um formato de exibição personalizado para os valores exibidos no DynamicField objeto . Se a DataFormatString propriedade não estiver definida, o valor do campo será exibido sem nenhuma formatação especial. Para obter mais informações, consulte Tipos de formatação.

Observação

Quando a DynamicField.HtmlEncode propriedade é true, o valor do campo é codificado em HTML para sua representação de cadeia de caracteres antes que a cadeia de caracteres de formatação seja aplicada. Para alguns objetos, como datas, talvez você queira controlar como o objeto é exibido com uma cadeia de caracteres de formatação. Nesses casos, você deve definir a DynamicField.HtmlEncode propriedade como false.

Por padrão, a cadeia de caracteres de formatação é aplicada ao valor do campo somente quando o controle associado a dados que contém o DynamicField objeto está no modo somente leitura. Para aplicar a cadeia de caracteres de formatação aos valores de campo quando eles estiverem no modo de edição, defina a ApplyFormatInEditMode propriedade como true.

A cadeia de caracteres de formatação pode ser qualquer cadeia de caracteres literal e geralmente inclui um espaço reservado para o valor do campo. Por exemplo, na cadeia de caracteres de formatação "Valor do Item: {0}", o valor do campo é substituído pelo {0} espaço reservado quando a cadeia de caracteres é exibida no DynamicField objeto . O restante da cadeia de caracteres de formatação é exibido como texto literal.

Observação

Se a cadeia de caracteres de formatação não incluir um espaço reservado, o valor do campo da fonte de dados não será incluído no texto de exibição final.

Confira também

• Tipos de formatação no .NET