LayoutView.CardCaptionFormat Property

Gets or sets card caption text patterns.

Namespace: DevExpress.XtraGrid.Views.Layout

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

[DefaultValue("")]
[XtraSerializableProperty]
[DXCategory("CardOptions")]
public string CardCaptionFormat { get; set; }
<DefaultValue("")>
<XtraSerializableProperty>
<DXCategory("CardOptions")>
Public Property CardCaptionFormat As String

Property Value

Type Default Description
String

String.Empty

A string value specifying the card caption's text pattern.

Remarks

Use the CardCaptionFormat property to specify a pattern used to generate a card's caption. The following placeholders can be used:

  • {0} - represents the current record number.
  • {1} - represents the number of records specified by the LayoutView.RecordCount property.
  • {2} - represents the display value of the first field in the ColumnView.Columns collection.
  • {3} - represents the display value of the second field in the ColumnView.Columns collection.
  • etc.

To get a specific card's caption according to the CardCaptionFormat format, use the LayoutView.GetCardCaption method.

If displaying column values within card captions, values are formatted as specified by the column's GridColumn.DisplayFormat property. It's also possible to supply custom display values by handling the ColumnView.CustomColumnDisplayText event. See Formatting Cell Values to learn more.

See Also