WorksheetControl::GetColDesignations

GetColDesignations

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

Description

Gets column designations for entire worksheet control in form of string Possible values for designations: 'X' - X column 'Y' - Y column 'Z' - Z column 'E' - Y error column 'L' - label column 'M' - X error column 'N' - ignore column

Gets column designations for entire worksheet in form of string Possible values for designations: 'X' - X column 'Y' - Y column 'Z' - Z column 'E' - Y error column 'L' - label column 'M' - X error column 'N' - ignore column

Syntax

string GetColDesignations( )

void GetColDesignations( string & strDesignations )

Parameters

strDesignations

Return

Examples

EX1

#include <Dialog.h>
#define IDC_WORKSHEET 1001

// Assumes the current window is worksheet
void WorksheetControl_GetColDesignations_ex1(Dialog& dlg)
{
        Worksheet wks = Project.ActiveLayer();
        string         strWksName = wks.GetName();
        WorksheetControl wc = dlg.GetItem(IDC_WORKSHEET);
        wc.Attach(strWksName);
        string strDesignations = wc.GetColDesignations();
}

EX2

#include <Dialog.h>
#define IDC_WORKSHEET 1001
// Assumes the current window is worksheet
void WorksheetControl_GetColDesignations_ex2(Dialog& dlg)
{
        Worksheet wks = Project.ActiveLayer();
        string         strWksName = wks.GetName();
        WorksheetControl wc = dlg.GetItem(IDC_WORKSHEET);
        wc.Attach(strWksName);
        string strDesignations;
        wc.GetColDesignations(strDesignations);
}