Grid::IsLabelsShown

IsLabelsShown

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

Description

to check the specified type label is show or hidden

Syntax

BOOL IsLabelsShown( UINT nType, BOOL bColLabels = true )

Parameters

nType: [input] the type of labels, refer to this list or see RCLT_ emnu in OC_const.h
bColLabels: [input] true for column labels, false for row labels

Return

TRUE if this type label is show else FALSE

Examples

EX1

void Grid_IsLabelsShown_ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(wks)
    {
        Grid gg;
        gg.Attach(wks);
 
        bool bShow = gg.IsLabelsShown(RCLT_UNIT);
        if(bShow)
                out_str("UNIT label is shown.")
    }
}

EX2

// This example creates a worksheet with 3 columns. Then adds two user defined parameters to the row label. 
void Grid_SetUserDefinedLabelNames_ex2()
{
    Worksheet wks = Project.ActiveLayer();
    if(wks)
    {
        Worksheet wks;
        wks.Create("Origin", CREATE_VISIBLE);
        wks.AddCol();
        Grid gg;
        gg.Attach(wks);  // attach the grid to the worksheet
        vector<string> vsUDLs = {"Operator", "MachineID"};
        gg.SetUserDefinedLabelNames(vsUDLs);   // Add two user defined labels. 
        bool bShow = gg.IsLabelsShown(RCLT_UDL);
        gg.ShowLabels(RCLT_UDL, !bShow);
        bShow = gg.IsLabelsShown(RCLT_UDL+1);
        gg.ShowLabels(RCLT_UDL+1, !bShow);
        wks.GetPage().Refresh();        
    }
}