Member variable XbpTabPage():caption Foundation

The caption of the XbpTabPage object.

Attribute: EXPORTED
Data type: Character string, Numeric, Object ("")

The caption is the part of the XbpTabPage object displayed within the tab. The caption can be a character string, an icon or a bitmap. If the caption is a character string, the string is assigned to the instance variable :caption. If the caption is a bitmap, either a numeric resource ID of a BITMAP resource (Windows Bitmap file format) or an XbpBitmap object is assigned to the instance variable. If a resource ID is used, it must be a BITMAP resource defined in a resource file that is linked to the EXE file. To use an icon as caption, an XbpIcon object must be assigned. In all cases, the assignment has to occur before the method :create() is executed. Using an XbpBitmap object to define the caption allows to display images defined in various image file formats. Furthermore, if a transparent color has been defined for the bitmap object, transparent areas in the image are automatically replaced with the background color defined for the tab page object.

If an XbpBitmap or XbpIcon object is assigned to the :caption property, one of the methods :load() or :loadFile() must have previously been called. For bitmaps constructed in memory, method :make() must have been used. Moreover, it is discouraged to reuse bitmap or icon objects which define a caption to load a different image. Instead, a new bitmap or icon object should be created for that purpose.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.