In This Topic ▼

LImageViewerCell::EditCellTag

Summary

Modifies a tag from the specified cell.

Syntax

#include "ltwrappr.h"

L_INT LImageViewerCell::EditCellTag(uRow, uAlign, pTagInfo, uFlags)

Parameters

L_UINT uRow

The number of rows to count before reaching the Sub-cell tag to be modified.

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.

DISPCELLTAGINFO * pTagInfo

Pointer to the DISPCELLTAGINFO structure that contains information about the tag.

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 modifies the Cell tag. The cell tag is the tag that appears on all the frames in the cell. You can create a cell tag using the LImageViewerCell::SetCellTag function.

To create a tag that appears only on the desired frame, use the LImageViewerCell::SetSubCellTag function.