Column::SetCustomDisplay

SetCustomDisplay

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

Description

To set the custom date display format. This action is same as setup Custom Date Formats in Preference: Options : Miscellaneous.

Syntax

BOOL SetCustomDisplay( LPCSTR lpcszDisplay, bool bUndo = false )

Parameters

lpcszDisplay: [input] The custom date display string.
bUndo: [input] true to support undo mechanism.

Return

TRUE if succesfull, otherwise FALSE.

Examples

EX1

void    Column_SetCustomDisplay_Ex1()
{
    Worksheet wks = Project.ActiveLayer();
    if(!wks)
        return;
    
    Column col(wks, 0);
    if( col )
    {
        col.SetFormat(OKCOLTYPE_DATE);
        col.SetSubFormat(LDF_OBJ_CUSTOM);
        if( col.SetCustomDisplay("dd-MM-yy") )
            printf("The custom display format of Column %u is %s\n", col.GetIndex()+1, col.GetCustomDisplay());
        else
            printf("Fail to set custom format to this column\n");
    }
}