In This Topic ▼

LImageViewerCell::SetSubCellTag

Summary

Sets a sub-cell tag on a specific location in a specific cell or sub-cell.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::SetSubCellTag(nSubCellIndex, uRow, uAlign, uType, pString, uFlags)

Parameters

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell. This sub-cell is where to place the tag. Pass -2 to refer to the selected sub-cell.

L_UINT uRow

The number of rows to count before placing the tag.

L_UINT uAlign

Value that specifies the origin point from which to count the rows specified in the uRow parameter. For example, if uAlign is DISPWIN_ALIGN_BOTTOMLEFT and uRow is 4, the application will count 4 rows from the bottom and place the tag on that location. Possible values are:

Value	Meaning
DISPWIN_ALIGN_TOPLEFT	[0x0000] Start counting rows from the top of the cell. The tag is left justified.
DISPWIN_ALIGN_LEFTCENTER	[0x0001] Place the tag in the center, based on the height of the cell. The tag is left-justified.
DISPWIN_ALIGN_BOTTOMLEFT	[0x0002] Start counting rows from the bottom of the cell. The tag is left justified.
DISPWIN_ALIGN_TOPCENTER	[0x0003] Place the tag in the center, based on the width of the cell. The tag is top-justified.
DISPWIN_ALIGN_BOTTOMCENTER	[0x0004] Place the tag in the center, based on the width of the cell. The tag is bottom-justified.
DISPWIN_ALIGN_TOPRIGHT	[0x0005] Start counting rows from the top of the cell. The tag is right justified.
DISPWIN_ALIGN_RIGHTCENTER	[0x0006] Place the tag in the center, based on the height of the cell. The tag is right-justified.
DISPWIN_ALIGN_BOTTOMRIGHT	[0x0007] Start counting rows from the bottom of the cell. The tag is right justified.

L_UINT uType

Value that represents the type of tag to be added. Possible values are:

Value	Meaning
DISPWIN_TYPE_USERDATA	[0x0000] User data tag
DISPWIN_TYPE_SCALE	[0x0001] Scale tag
DISPWIN_TYPE_WLCENTERWIDTH	[0x0002] Window level tag
DISPWIN_TYPE_FIELDOFVIEW	[0x0003] Field of view tag
DISPWIN_TYPE_OWNERDRAW	[0x0004] Owner draw tag
DISPWIN_TYPE_FRAME	[0x0005] Frame tag.
DISPWIN_TYPE_RULERUNIT	[0x0006] Ruler unit tag.

LPTSTR pString

Character string that contains a custom tag. This parameter is only used if uType is set to DISPWIN_TYPE_USERDATA.

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 Sub-Cell tag. The sub-cell tag is the tag that appears only on one frame of the cell frames. You can create a sub-cell tag using the LImageViewerCell::SetSubCellTag function. To create a tag that appears on all the frames of the cell, use the LImageViewerCell::SetCellTag function.