Help Version 19.0.2017.10.27
References ▼
#include "ltwrappr.h"
L_INT LImageViewerCell::GetSubCellTag(nSubCellIndex, uRow, uAlign, pTagInfo, uFlags)
L_INT nSubCellIndex; |
index into the image list attached to the cell |
L_UINT uRow; |
row index |
L_UINT uAlign; |
flag |
DISPCELLTAGINFO * pTagInfo; |
pointer to a structure |
L_UINT uFlags; |
reserved for future |
Retrieves the sub-cell tag information.
| Parameter | Description | |
| nSubCellIndex | A zero-based index into the image list attached to the cell. This sub-cell contains the image that contains the bitmap region that needs to be retrieved. Pass -2 to refer to the selected sub-cell. | |
| uRow | The number of rows to count before reaching the Sub-cell tag to be retrieved. | |
| 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 (overlay text) 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] Place the tag in the center, based on the height of the cell The tag will be 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] Place the tag in the center, based on the width of the cell. The tag will be top-justified. | |
| DISPWIN_ALIGN_BOTTOMCENTER | [0x0004] Place the tag in the center, based on the width of the cell. The tag will be 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] Place the tag in the center, based on the height of the cell. The tag will be right-justified. | |
| DISPWIN_ALIGN_BOTTOMRIGHT | [0x0007] Start counting rows from the bottom of the cell. The tag will be right justified. | |
| pTagInfo | Pointer to the DISPCELLTAGINFODISPCELLTAGINFO structure that contains information about the tag. | |
| uFlags | Reserved for future use. Pass 0. | |
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
If you are planning to retrieve the text, you should allocate enough space to hold the tag text.
This function retrieves 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.
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. |
For an example, refer to LImageViewerCell::BeginUpdate.