Worksheet::ClearLabelsContent

ClearLabelsContent

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

Description

Clear content of a label of the given type.

Syntax

BOOL ClearLabelsContent( UINT nType, int nPos = -1, int nC1 = 0, int nC2 = -1, BOOL bColheaders = TRUE )

Parameters

nType: [input] Label type. It must come from enumerated values RCLT_INVALID etc.; special for RCLT_PARAM, it will clear all RCLT_PARAMs and also labels between them.
nPos: [input] The position of label to clear. Default of -1 means use nType, otherwise use iPos.
nC1: [input] start index to clear, default to 0 means from the first column or row define on bColheader
nC2: [input] end index to clear, default to -1 means to the end of column or row define on bColheader
bColheaders: [input] TRUE for column headers, FALSE for row headers.; Note that for flat sheets this argument must be TRUE.

Return

TRUE if success, otherwise FALSE

Examples

EX1

//Clear the content of the comment label.
void Worksheet_ClearLabelsContent_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    
    if ( !wks )
    {
        out_str("No active worksheet");
        return;
    }
    
    UINT nType = RCLT_COMMENT;
    BOOL bRet = wks.ClearLabelsContent(nType);
    printf("bRet = %d\n", bRet);
    
    return;
}