In This Topic ▼

L_DispContainerSetSubCellTag

Summary

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

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerSetSubCellTag(hCellWnd, nSubCellIndex, uRow, uAlign, uType, pString, uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. 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] The tag is placed in the center, based on the height of the cell, and 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] The tag is placed in the center, based on the width of the cell, and is top justified.
DISPWIN_ALIGN_BOTTOMCENTER	[0x0004] The tag is placed in the center, based on the width of the cell, and 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] The tag is placed in the center, based on the height of the cell, and 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

String containing a custom tag. This parameter is only used if uType is set to DISPWIN_TYPE_USERDATA.

L_UINT uFlags

Reserved for future use. Pass 0.

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 function L_DispContainerSetSubCellTag. To create a tag that appears on all the frames of the cell, use L_DispContainerSetCellTag.