2.1.14.4.23 wks_set_show_labels

Description

Configure worksheet column label region display options

Syntax

bool wks_set_show_labels( Worksheet & wks, int nLine1 = -1, int nLine2 = -1, int nLine3 = -1, int nLine4 = -1, int nLine5 = -1 )

Parameters

wks

[input] the worksheet to set show labels

nLine1

[input] the 1st label line, -1 if not show, otherwise one of RCLT_LONG_NAME,RCLT_UNIT,RCLT_COMMENT,RCLT_PARAM, or RCLT_PARAM+1 for showing Parameter 2

nLine2

[input] similar, but for the 2nd label row

nLine3

[input] similar, but for the 3rd label row

nLine4

[input] similar, but for the 4th label row

nLine5

[input] similar, but for the 5th label row

Return

true if success

Examples

EX1

//For this example to run, active a workbook in current project first
//configure active sheet to show Comment on 1st line and Long Name on second and Parameter3 at 3rd line
void wks_set_show_labels_ex1()
{
    Worksheet wks = Project.ActiveLayer();
    wks_set_show_labels(wks, RCLT_COMMENT, RCLT_LONG_NAME, RCLT_PARAM+2);
}

Remark

See Also

wks_add_show_labels

Header to Include

origin.h

Reference