JVCL Help:TJvTabBarItem.GetImages

From Project JEDI Wiki
Jump to navigationJump to search
JEDI Visual Component Library Help

Search in JVCL Help

 
Search in all projects
 

Summary

Provides access to images drawn on tabs in the tabbed-bar control.


Pascal

 functionGetImages: TCustomImageList;


Return Value

TCustomImageList - Images to draw on tabs in the tabbed-bar control.


Description

GetImages is a TCustomImageList function used to access images to be drawn on the tabs in the TabBar control. The return value for the method is the value assigned to the TabBar.Images property, or Nil when an image list has not been assigned.
GetImages is used when tabs are drawn using the TJvTabBarPainter instances assigned to the TabBar control. The value in ImageIndex is used to access a specific TImage in the image list for the tabbed bar control. When ImageIndex contains -1 or GetImages returns Nil, no image will be drawn for the current tab definition. The value in Enabled is used to determine the drawing state for the image on the tab.
GetImages is also used when TJvTabBarPainter calculates the display width required for the tab, and adjusts the width to accommodate both the image from an assigned image list and the value in the Caption property.


See Also

TJvTabBarItem.ImageIndex, TJvTabBarItem.Enabled, TJvTabBarItem.Caption, TJvTabBarPainter, TJvModernTabBarPainter


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