L_DispContainerGetFullExploded

Summary

Returns a value that indicates whether a cell is exploded or not.

Syntax

L_LTIVW_API L_INT L_DispContainerGetFullExploded(hCon, pbExploded, uFlags);

Parameters

HDISPCONTAINER hCon

Handle to the container.

L_BOOL * pbExploded

Pointer to a variable to be updated with the current explode status. Possible values are:

L_UINT uFlags

Reserved for future. Must be 0.

Returns

Comments

The exploded mode is when the cell layout is divided into multiple cells and sub-cells, and the user wants to temporarily view the selected cell / sub-cell and makes it occupy the whole display area. This can be achieved by either using this property, or by simply double clicking any of the visible sub-cells.

To explode a cell, call to L_DispContainerSetFullExploded 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_DispContainerSetFullExploded
• L_DispContainerCreate
• L_DispContainerInsertCell
• L_DispContainerRemoveCell
• L_DispContainerGetCellCount
• L_DispContainerGetCellWindowHandle
• L_DispContainerSetCellBitmapList
• L_DispContainerSetCellTag
• L_DispContainerSetCellProperties
• L_DispContainerGetCellProperties
• L_DispContainerGetCellPosition
• L_DispContainerRepositionCell
• L_DispContainerGetCellBitmapList
• L_DispContainerGetCellBounds
• L_DispContainerFreezeCell
• L_DispContainerIsCellFrozen
• L_DispContainerSelectCell

Topics

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

Example

This function toggle whether the full explode feature is on or off.

L_INT L_DispContainerGetFullExplodedkExample(HDISPCONTAINER hCon) 
{ 
   L_BOOL bExploded; 
   L_DispContainerGetFullExploded(hCon, &bExploded, 0); 
 
   L_DispContainerSetFullExploded(hCon, !bExploded, 0); 
 
   MessageBox(NULL, TEXT("The full explode mode is now On, please double click on any click to preform the full explode"), TEXT("Status"), MB_OK); 
 
   return SUCCESS; 
}