Column::SetParameter

SetParameter

Description

Set one parameter in a column label.

Syntax

BOOL SetParameter( LPCTSTR lpcszParam, int index = 0 )

Parameters

lpcszParam

[input] the parameter value to set

index

[input] the parameter index, default is 0

Return

TRUE if OK, otherwise FALSE.

Examples

EX1

// Create a worksheet and add a Parameter
void Column_SetParameter_Ex1()
{
    Worksheet    wks;
    wks.Create("Origin", CREATE_VISIBLE);
    wks.Columns(0).SetParameter("First", 0);
    wks.Columns(1).SetParameter("Second", 0);
    // Parameters have been set but aren't displayed yet
    Grid    grd;
    grd.Attach(wks);
    grd.ShowLabels(RCLT_PARAM);
}

Remark

Sets one built-in parameter label in a column. Please note that if you need to use User Parameters, you should use SetExtendedLabel.

See also this LabTalk page.

See Also

Column::GetExtendedLabel, Column::SetExtendedLabel

Header to Include

origin.h