DisplayFormatAttribute.DataFormatString Propiedad

Definición

Espacio de nombres:

System.ComponentModel.DataAnnotations

Ensamblado:

System.ComponentModel.Annotations.dll

Source:

DisplayFormatAttribute.cs

Obtiene o establece el formato de presentación del valor de 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 de propiedad

String

Cadena de formato que especifica el formato de presentación del valor del campo de datos. El valor predeterminado es una cadena vacía (""), lo que indica que no se aplica ningún formato especial al valor del campo.

Ejemplos

En los ejemplos siguientes se muestra cómo usar la DataFormatString propiedad para establecer el formato de presentación de los campos de datos. En el primer ejemplo se establece el formato de presentación de un campo de datos de tipo de moneda. En el segundo ejemplo se establece el formato de presentación de un campo de datos de tipo de fecha.

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

Comentarios

Utilice la DataFormatString propiedad para especificar un formato de presentación personalizado para los valores que se muestran en el DynamicField objeto . Si no se establece la DataFormatString propiedad, el valor del campo se muestra sin ningún formato especial. Para obtener más información, consulte Aplicar formato a tipos.

Nota

Cuando la DynamicField.HtmlEncode propiedad es true, el valor del campo se codifica en HTML en su representación de cadena antes de aplicar la cadena de formato. Para algunos objetos, como las fechas, es posible que desee controlar cómo se muestra el objeto con una cadena de formato. En esos casos, debe establecer la DynamicField.HtmlEncode propiedad falseen .

De forma predeterminada, la cadena de formato se aplica al valor de campo solo cuando el control enlazado a datos que contiene el DynamicField objeto está en modo de solo lectura. Para aplicar la cadena de formato a los valores de campo cuando están en modo de edición, establezca la ApplyFormatInEditMode propiedad trueen .

La cadena de formato puede ser cualquier cadena literal y normalmente incluye un marcador de posición para el valor del campo. Por ejemplo, en la cadena de formato "Item Value: {0}", el valor del campo se sustituye por el {0} marcador de posición cuando la cadena se muestra en el DynamicField objeto . El resto de la cadena de formato se muestra como texto literal.

Nota

Si la cadena de formato no incluye un marcador de posición, el valor del campo del origen de datos no se incluye en el texto para mostrar final.

Consulte también

• Aplicar formato a tipos en .NET