Column::GetSubFormat

GetSubFormat

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

Description

Get the SubFormat used by a column.

Syntax

int GetSubFormat( )

Parameters

Return

The subformat as an integer enumerated from 0

Examples

EX1

// A worksheet with at least one column must exist in the project
void    Column_GetSubFormat_Ex1()
{
    WorksheetPage wp = Project.WorksheetPages(0);
    if(!wp)
        return;
    
    Worksheet wks(wp.GetName());
    int iSubFormat = wks.Columns(0).GetSubFormat();
    printf("SubFormat type number is %u\n", iSubFormat);
}

Remark

Get the SubFormat used by a column.

The list of available subformats varies for each column type.

Each Format have some SubFormat, you can choose different Format in the Worksheet Column Properties dialog and see the SubFormat corresponding to that Format at the 'Display' label. The GetSubFormat and SetSubFormat function will return or use the index of the combo box in the label to represent different SubFormat.