LayoutView.GetCardCaption(Int32) Method

Returns the specified card's caption text.

Namespace: DevExpress.XtraGrid.Views.Layout

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public virtual string GetCardCaption(
    int rowHandle
)
Public Overridable Function GetCardCaption(
    rowHandle As Integer
) As String

Parameters

Name Type Description
rowHandle Int32

An integer value specifying the card by its row handle.

Returns

Type Description
String

A string value representing the specified card's caption text.

Remarks

The pattern used to generate a cards' caption text is specified by the View's LayoutView.CardCaptionFormat property. The GetCardCaption method allows you to get the text displayed within a specific card's caption.

NOTE

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetCardCaption member must not be invoked for these Views. The GetCardCaption member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

See Also