Member variable XbpTreeViewItem():markedImage Foundation

Resource ID, XbpBitmap or XbpIcon object of the bitmap or icon which indicates the marked state.

Attribute: EXPORTED
Data type: Numeric | Object (-1)

The resource ID of a bitmap (Windows Bitmap file format) or icon can be assigned to the instance variable :markedImage. The image is displayed when the XbpTreeViewItem object is marked (when it is the current one). Resource IDs must be defined in a resource file which is linked to the EXE file using the resource compiler. Instead of a resource ID, an object of the XbpBitmap or XbpIcon classes can be assigned. Assigning a XbpBitmap object allows the usage of images defined in various image file formats (.BMP/.JPG/.PNG). Furthermore, if a transparent color has been defined for the bitmap object, transparent areas within the image are automatically replaced with the background color defined for the XbpTreeView object.

If method :create() of the tree view item has been executed, assigning a new icon or bitmap :markedImage changes the image displayed by the item. This can be used to change a tree view item's marked image dynamically while it is being displayed. See method:setMarkedImage() for further information.

If an XbpBitmap or XbpIcon object is assigned to the :markedImage 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 use the object to load or define a different image as long as it is assigned to the treeview item. Instead, a new XbpBitmap or XbpIcon 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.