2.2.4.46.34 Worksheet::GetLabelRow

Description

Provides Label row index for a given Label type ID

Syntax

int GetLabelRow( int nLabelType, BOOL bColLabel = true )

Parameters

nLabelType
[input]label type ID for which label row index is sought. Like RCLT_LONG_NAME, RCLT_SPARKLINE etc
bColLabel
[input]when TRUE refers to column labels else refers to row labels

Return

returns the label row index as a negative integer such that the last label index as -1

Examples

EX1

//Output Label row index for a given Label type ID 
void Worksheet_GetLabelRow_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;
    
    int nLabelRow = wks.GetLabelRow(RCLT_LONG_NAME);
    printf("Label LongName's Row is %d", nLabelRow);
}

Remark

See Also

Worksheet::GetLabelType

Header to Include

origin.h