AxisObject::GetTypeFormatEtc

GetTypeFormatEtc

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

Description

to get the type of tick label

Syntax

int GetTypeFormatEtc( int & nType, string * pstr = NULL, int * pnFormat = NULL )

Parameters

nType: [output]Axis label type, enum as OULABELTYPE
pstr: [output]Text string for specific types :; For OULABEL_TEXT, OULABEL_DATASET, OULABEL_CATEGORICAL, it means dataset name; For OULABEL_STROBJ, it means tick-indexed string.; For other types, it should be NULL.
pnFormat: [output]Display format for OULABEL_NUMERIC, OULABEL_TIME, OULABEL_DATE, OULABEL_MONTH, OULABEL_DAYOFWEEK, OULABEL_COLUMN

Return

Return 0 if no error, otherwise error code enumeration as AXISLABELACCESSERROR

Examples

//Get the type of x axis tick label.
void AxisObject_GetTypeFormatEtc_Ex1()
{
    GraphLayer gl = Project.ActiveLayer();    
 
    AxisObject aoXLabel = gl.XAxis.AxisObjects(AXISOBJPOS_LABEL_FIRST);
    int    nType, nFormat;
        string  str;                            
    int iRet;
    iRet = aoXLabel.GetTypeFormatEtc(nType, &str, &nFormat);
    if(iRet ==0)
    {
        out_str("Get successfully");
        out_int("Type:", nType);
    }
}