LImageViewer::FreezeSubCell

Summary

Freezes the sub-cell at the specified index.

Syntax

#include "ltwrappr.h"

L_INT LImageViewer::FreezeSubCell(nCellIndex, nSubCellIndex, bFreeze, uFlags)

Parameters

L_INT nCellIndex

A zero based index of the cell to apply the effect on.

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This sub-cell will be toggled to frozen or not frozen. Pass -1 to apply this effect on all sub-cells. Pass -2 to apply this effect on the selected sub-cell.

L_BOOL bFreeze

Flag that indicates whether to freeze or unfreeze the sub-cell at the specified index. Possible values are:

Value Meaning
TRUE Freeze the sub-cell.
FALSE Unfreeze the sub-cell.

L_UINT uFlags

Flags that determine whether to apply the feature on one or more cells. This value can only be used when the cell is attached to the LImageViewer through the function LImageViewer::InsertCell. Possible values are:

Value Meaning
CELL_APPLYTOTHIS [0x00000000] Apply the feature to this cell only.
CELL_APPLYTOALL [0x10000000] Apply the feature to all the cells in the Image Viewer.
CELL_APPLYTOSELECTED [0x20000000] Apply the feature to the selected cells in the Image Viewer.

Returns

Value Meaning
SUCCESS The function was successful.
< 1 An error occurred. Refer to Return Codes.

Comments

The properties of a frozen sub-cell cannot be modified except by manually setting them using LImageViewerCell::SetActionProperties function.

To determine whether a sub-cell is frozen, call the LImageViewerCell::IsSubCellFrozen function.

To determine whether a cell is frozen, call LImageViewerCell::IsCellFrozen function.

To freeze all cells call LImageViewerCell::FreezeCell function.

Required DLLs and Libraries

See Also

Functions

Topics

Example

Help Version 22.0.2022.12.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Medical Image Viewer C++ Class Library Help
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.