L_DispContainerCheckTitlebarIcon

Summary

Checks or unchecks the specific title bar icon of the specific cell or sub-cell.

Syntax

L_LTIVW_API L_INT L_DispContainerCheckTitlebarIcon(hCellWnd, nSubCellIndex, nIconIndex, bCheck, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. This function will check or uncheck the title bar icon of this sub-cell. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

L_INT nIconIndex

A zero-based index of the icon that the user needs to check or uncheck. Pass -1 to check or uncheck all icons of the specific sub-cell.

L_BOOL bCheck

Flag that indicates whether to check or uncheck the specific title bar icon. Possible values are:

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

To retrieve the status of a specific title bar icon whether it is checked or unchecked, call the L_DispContainerIsTitlebarIconChecked function.

Required DLLs and Libraries

• LTIVW
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions

• L_DispContainerCreate
• L_DispContainerDestroy
• L_DispContainerIsTitlebarIconChecked
• L_DispContainerGetTitlebarProperties
• L_DispContainerIsTitlebarEnabled
• L_DispContainerSetIconProperties
• L_DispContainerGetIconProperties
• L_DispContainerSetTitlebarProperties
• L_DispContainerShowTitlebar

Topics

• Image Viewer Cells
• Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to L_DispContainerShowTitlebar.