2.2.4.22.20 Grid::GetUserDefinedLabelNames

GetUserDefinedLabelNames

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

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]);
    }
}