LayoutView.GetCardCaption(Int32) Method
Returns the specified card’s caption text.
Namespace: DevExpress.XtraGrid.Views.Layout
Assembly: DevExpress.XtraGrid.v19.1.dll
Declaration
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.
- GridControl.MainView - returns the top most View in a grid;
- GridControl.FocusedView - returns the focused View;
- GridControl.DefaultView - returns the currently maximized View;
- the sender parameter of View specific events;
- GridView.GetDetailView - returns a detail clone View for a specific master row.