LImageViewer::SetSubCellTag

#include "ltwrappr.h"

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

L_INT nCellIndex;

/* index of the cell */

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

L_UINT uRow;

/* row index */

L_UINT uAlign;

/* flag */

L_UINT uType;

/* tag type */

LPTSTR pString;

/* string containing a custom tag */

L_UINT uFlags;

/* reserved for future */

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

Parameter

Description

nCellIndex

A zero-based index of the cell which to place the tag (overlay text). Pass -2 to place the sub-cell tag in the selected cell.

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.

uRow

The number of rows to count before placing the tag.

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.

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.

pString

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

uFlags

Reserved for future use. Pass 0.

Returns

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

Required DLLs and Libraries

LTIVW

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

See Also

Functions:

LImageViewer::EditCellTag, LImageViewer::GetCellTag, LImageViewer::SetCellTag, LImageViewer::DeleteSubCellTag, LImageViewer::EditSubCellTag, LImageViewer::Create, LImageViewer::RemoveCell, LImageViewer::InsertCell, LImageViewer::GetCellCount, LImageViewer::SetCellProperties, LImageViewer::GetCellProperties, Class Members

Topics:

Image Viewer Cells

 

Window Control/Image Viewer Functions: Image Viewer Cells

Example

For an example, refer to LImageViewer::BeginUpdate.