LImageViewer::SetCellTag
#include "ltwrappr.h"
L_INT LImageViewer::SetCellTag (nCellIndex, uRow, uAlign, uType, pString, uFlags);
L_INT nCellIndex; |
/* index of the cell */ |
L_UINT uRow; |
/* row index */ |
L_UINT uAlign; |
/* flag */ |
L_UINT uType; |
/* tag type */ |
L_UCHAR * pString; |
/* string containing a custom tag */ |
L_UINT uFlags; |
/* reserved for future use */ |
Sets a tag on a specific location in a specific cell. This function is available only in the Medical Imaging Suite toolkits.
Parameter |
Description |
|
nCellIndex |
Index of the cell in which to place the tag. Pass 1 to set the tag in all cells in the container. Pass -2 to set the tag in the selected cells in the container. |
|
uRow |
The number of rows to count before placing the tag. The maximum number of rows and columns that a cell can have is 4 X 8. |
|
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 will be 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 will be 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 will be 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 will be 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 |
[0x0004] Frame tag. |
pString |
String containing 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
If two tags are written to the same location, the second tag written will overwrite the first tag.
To change the quality of the tag text, call LImageViewer::SetProperties.
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
Example
For an example, refer to LImageViewer::Create.