LImageViewerCell::SetCellScaleMode

Summary

Sets the current scale mode for the specified cell or sub-cell. This feature is available in version 16 or higher.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::SetCellScaleMode(nSubCellIndex, uScaleMode, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. The sub-cell with nSubCellIndex, will have its scale mode set. Pass -2 to set the scale mode of the selected sub-cell.

L_UINT uScaleMode

Flag that indicates the type of the scale.  Possible values are:

Value Meaning
CONTAINER_SCALEMODE_NORMAL [0x00000000] No scale mode applied. This is the default value.
CONTAINER_SCALEMODE_FIT [0x00000001] The image will fit to the sub-cell boundaries.
CONTAINER_SCALEMODE_FITWIDTH [0x00000002] The image width will fit to the sub-cell boundaries.
CONTAINER_SCALEMODE_FITHEIGHT [0x00000003] The image height will fit to the image boundaries.

L_UINT uFlags

Flags that determine whether to apply the feature on the one cell only, or more than one cell. 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

Currently, there are two ways to fit an image to a cell. One is by setting the bIsFit value of DISPCELLPROPERTIES structure to true (also remembering to set the corresponding uMask value), and then sending this structure to the LImageViewerCell::SetCellProperties function. The other method is by using the LImageViewerCell::GetCellScale and LImageViewerCell::SetCellScale functions. In order to be able to use these functions make sure that bIsFit is set to FALSE.

To get the scale of cell or sub-cell use the LImageViewerCell::GetCellScale function.

To set the scale of cell or sub-cell use the LImageViewerCell::SetCellScale function.

To set the properties of the scale action use the LImageViewerCell::SetActionProperties function.

To get the properties of the scale action use the LImageViewerCell::GetActionProperties function.

To set the scale mode of cell or sub-cell use the LImageViewerCell::SetCellScaleMode function.

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to LImageViewerCell::BeginUpdate.

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 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.