GetButtonImageIndex function

Declaration

function GetButtonImageIndex(idButton: TButtonImage): Integer

Arguments

Function result

Ordinal position for the specified button identifier, or -1 when not found.

Description

GetButtonImageIndex is an Integer function used to retrieve the position for the specified button identifier in the LCL glyph image list.

idButton is the TButtonImage value for the button identifier requested in the routine. It is used to identify the resource name in BitBtnResNames for the button glyph. The resource name is located in the LCLGlyphs image list using its GetImageIndex method.

The return value contains the ordinal position in LCLGlyphs where the corresponding resource name is stored, or -1 if the resource name is not found.

See also

• TButtonImage
• BitBtnResNames
• TLCLGlyphs.GetImageIndex
• LCLGlyphs