DisplayFormatAttribute.DataFormatString Propriedade

Definição

Obtém ou define o formato de exibição do valor do campo.Gets or sets the display format for the field value.

public:
 property System::String ^ DataFormatString { System::String ^ get(); void set(System::String ^ value); };
public string DataFormatString { get; set; }
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.A formatting string that specifies the display format for the value of the data field. O padrão é uma cadeia de caracteres vazia (""), o que indica que nenhuma formatação especial é aplicada ao valor do campo.The default is an empty string (""), which indicates that no special formatting is applied to the field value.

Exemplos

Os exemplos a seguir mostram como usar a DataFormatString propriedade para definir o formato de exibição dos campos de dados.The following examples show how to use the DataFormatString property to set the display format of data fields. O primeiro exemplo define o formato de exibição para um campo de dados de tipo de moeda.The first example sets the display format for a currency type data field. O segundo exemplo define o formato de exibição para um campo de dados de tipo de data.The second example sets the display format for a date type data field.

// 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 que são exibidos no DynamicField objeto.Use the DataFormatString property to specify a custom display format for the values that are displayed in the DynamicField object. Se a DataFormatString propriedade não for definida, o valor do campo será exibido sem nenhuma formatação especial.If the DataFormatString property is not set, the field's value is displayed without any special formatting. Para obter mais informações, consulte Tipos de formatação.For more information, see Formatting Types.

Observação

Quando a DynamicField.HtmlEncode propriedade é true , o valor do campo é codificado em HTML para sua representação de cadeia de caracteres antes da cadeia de caracteres de formatação ser aplicada.When the DynamicField.HtmlEncode property is true, the value of the field is HTML encoded to its string representation before the formatting string is applied. Para alguns objetos, como datas, talvez você queira controlar como o objeto é exibido com uma cadeia de caracteres de formatação.For some objects, such as dates, you might want to control how the object is displayed with a formatting string. Nesses casos, você deve definir a DynamicField.HtmlEncode propriedade como false .In those cases, you must set the DynamicField.HtmlEncode property to false.

Por padrão, a cadeia de caracteres de formatação é aplicada ao valor do campo somente quando o controle de vinculação de dados que contém o DynamicField objeto está no modo somente leitura.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. Para aplicar a cadeia de caracteres de formatação a valores de campo quando eles estiverem no modo de edição, defina a ApplyFormatInEditMode propriedade como true .To apply the formatting string to field values when they are in edit mode, set the ApplyFormatInEditMode property to 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.The formatting string can be any literal string and usually includes a placeholder for the field's value. Por exemplo, na cadeia de caracteres de formatação "valor {0} do item:", o valor do campo é substituído pelo {0} espaço reservado quando a cadeia de caracteres é exibida no DynamicField objeto.For example, in the formatting string "Item Value: {0}", the field's value is substituted for the {0} placeholder when the string is displayed in the DynamicField object. O restante da cadeia de caracteres de formatação é exibido como texto literal.The remainder of the formatting string is displayed as literal text.

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 final de exibição.If the formatting string does not include a placeholder, the field's value from the data source is not included in the final display text.

Aplica-se a