2.2.4.46.47 Worksheet::HideLabelByType

HideLabelByType

Description

Hides labels of the given type (if the label of that type is shown).

Syntax

BOOL HideLabelByType( UINT nType, BOOL bUndo = FALSE, 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.

bUndo

[input] Indicates if the operation needs to support undo (TRUE for supporting); default is FALSE.

bColHeaders

[input] TRUE for column headers, FALSE for row headers. For flat sheets this argument must

be TRUE.

Return

TRUE on success, FALSE on failure.

Examples

EX1

// Hide each label type
void Worksheet_HideLabelByType_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(wks)
    {
        for( int ii = 0 ; ii <= 10 ; ii++ )
            wks.HideLabelByType(ii, TRUE);
    }
}

Remark

See Also

Header to Include

origin.h