JVCL Help:IPageList.GetPageCaption
JVCL Help: IPageList.GetPageCaption Method
Search in JVCL Help
Search in all projectsSummary
Returns the caption for a page.
Pascal
functionGetPageCaption(AIndex: Integer): string;
Parameters
| Parameters | Description |
| AIndex: Integer | The 0-based index of the page whose caption is to be returned. |
Return Value
String - Caption for the page.
Description
GetPageCaption gets the string representing the caption of the page. If AIndex is outside the allowable range, this function should return an empty string or the value "unknown" or similar and not raise an exception or generate an error.
GetPageCaption is called by the IPageList user to retrieve the display name of a specific page. The GetPageCaption is only called at design-time when the IPageList consumer needs to display the pages in the IPageList implementation in its own design editor(s).
About
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
