2.2.4.28.40 MatrixObject::SetFormat

Description

Set the Matrix data format. Only OKCOLTYPE_NUMERIC is supported at present time.

Syntax

BOOL SetFormat( int nFormat )

Parameters

nFormat
[input] the column format currently only supports OKCOLTYPE_NUMERIC

Return

TRUE, set the Matrix format successfully, FALSE, unsuccessful.

Examples

EX1

// Matrix must exist in project
void MatrixObject_SetFormat_Ex1()
{
    MatrixObject moMy(Project.MatrixPages(0).GetName(), 0);
    if ( moMy.SetFormat(OKCOLTYPE_NUMERIC) )
        out_str("Format setting successfully!");
    else
        out_str("Format setting error!");
}

Remark

See Also

Column::SetFormat, MatrixObject::GetFormat

Header to Include

origin.h