Grid::GetUserDefinedLabelNames

Contents

Description

to get the name of user defined parameter labels

Syntax

BOOL GetUserDefinedLabelNames( StringArray & arr, BOOL bCol = TRUE )const

Parameters

arr
[output] string array to get the name of user defined labels
bCol
[input] true for column labels, false for row labels.

Return

TRUE if success else FALSE.

Examples

EX1

void Grid_GetUserDefinedLabelNames_ex1(bool bCol = true)
{
    Worksheet wks = Project.ActiveLayer();
    if(wks)
    {
        Grid gg;
        gg.Attach(wks); 

        vector<string> vsLabels;
        if(gg.GetUserDefinedLabelNames(vsLabels, bCol))
            for(int ii=0; ii<vsLabels.GetSize(); ii++)
                printf("%s\n", vsLabels[ii]);
    }
}

Remark

See Also

Grid::SetUserDefinedLabelNames Grid::GetShowLabels Grid::SetShowLabels

header to Include

origin.h