2.2.4.46.51 Worksheet::IsLabelTypeShown

Description

Returns TRUE or FALSE depending on whether the label of the given type is shown or not.

Syntax

BOOL IsLabelTypeShown( UINT nType, int * pnPos = NULL, BOOL bColHeaders = true )

Parameters

nType
[input] Label type. It must come from the following enumeration:
typedef enum {
RCLT_INVALID = -1,
RCLT_LONG_NAME,
RCLT_UNIT,
RCLT_COMMENT,
RCLT_PARAM,
} ROWCOLLABELTYPE;
plus an optional offset for RCLT_PARAM, like RCLT_PARAM + 1, RCLT_PARAM + 2, etc.
pnPos
[input] row position of the given label, -1 if not in label region
bColHeaders
[input] TRUE for column headers, FALSE for row headers. Note that for flat sheets
this argument must be TRUE.

Return

TRUE if shown, otherwise FALSE.

Examples

EX1

// The example returns the information about whether the column labels nType is shown or not.
void Worksheet_IsLabelTypeShown_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if ( !wks )
    {
        out_str("No active worksheet");
        return;
    }
    for(UINT nType = 0 ; nType < 8 ; nType++ )
    {
        BOOL bShown = wks.IsLabelTypeShown(nType);
        printf("Type %u shown = %d\n", nType, bShown);
    }
}

Remark

See Also

Worksheet::IsHeaderShown, Worksheet::IsGridLinesShown

Header to Include

origin.h