CardView.GetCardCaption(Int32) Method

Gets the specified card's caption text.

Namespace: DevExpress.XtraGrid.Views.Card

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 text displayed within card captions is specified by the View's CardView.CardCaptionFormat property. The property sets the caption text pattern and the actual caption texts may differ for different cards. It may depend upon field values within a card and card number. That actual caption text for a particular card can be obtained using the GetCardCaption method. This method can be used, for instance, when handling the CardView.CustomDrawCardCaption event. It will allow you to paint caption texts as specified by the CardView.CardCaptionFormat property.

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