LImageViewerCell::SetCellRegionHandle

Summary

Creates or updates the cell or sub-cell bitmap region by adding a region that is specified by a Windows region handle.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::SetCellRegionHandle(nSubCellIndex, hRgn, uCombineMode, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This sub-cell contains the image that contains the bitmap, which will contain the region handle. Pass -2 to refer to the selected sub-cell. If the cell contains 1 frame then the nSubCellIndex should be 0.

L_HRGN hRgn

Handle to the Windows region.

L_UINT uCombineMode

The action to take regarding the existing bitmap region, if one is defined. For descriptions of the possible values, refer to Creating a Bitmap Region.

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

This function sets the cell region handle. To get the bitmap region handle, use the LImageViewerCell::GetCellRegionHandle function.

Required DLLs and Libraries

See Also

Functions

Topics

Example

For an example, refer to LImageViewerCell::RegionCallBack.

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.