2.2.4.46.38 Worksheet::GetLabelType

GetLabelType

1 Description
2 Syntax
3 Parameters
4 Return
5 Examples
6 Remark
7 See Also
8 Header to Include

Description

Provides Label type ID for a given Label index

Syntax

int GetLabelType( int nLabelIndex, BOOL bColLabel = true )

Parameters

nLabelIndex: [input]label index for which label type is sought. Could be either a positive integer with the first label index as zero or a negative integer such that the last label index as -1;
bColLabel: [input]when TRUE refers to column labels else refers to row labels

Return

returns the label type ID like RCLT_LONG_NAME, RCLT_SPARKLINE etc

Examples

EX1

void Worksheet_GetLabelType_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;

    int nLabelType = wks.GetLabelType(-1);  //get the last label type
    printf("Label type is %d", nLabelType);
}