MatrixObject::SetExtendedLabel

SetExtendedLabel

Description

Set the matrix object label by label type.

Syntax

BOOL SetExtendedLabel(LPCSTR lpcszLabel, int nn, BOOL bByType = TRUE)

Parameters

lpcszLabel

[input] the label of matrix object

nn

[input] the type of extended label. 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.

bByType

[input] must be true

Return

Returns TRUE if successful, else return FALSE.

Examples

EX1

void MatrixObject_SetExtendedLabel_ex1()
{
        MatrixLayer ml = Project.ActiveLayer();
        if ( ml )
        {
                MatrixObject mo = ml.MatrixObjects(0);
                mo.SetExtendedLabel("label set to units", RCLT_UNIT);     
        }
}

Remark

See Also

MatrixObject::GetExtendedLabel, MatrixObject::SetLabel, MatrixObject::SetLongName, MatrixObject::SetComments, MatrixObject::SetUnits, MatrixObject::SetParameter, MatrixObject::SetParameters

header to Include

origin.h