2.2.4.27.21 MatrixLayer::SetSize

Description

Set the number of MatrixObjects in a matrix layer.

Syntax

BOOL SetSize( int nNumObjs = 1, int nNumRows = -1, int nNumCols = -1, DWORD dwCntrl = OCD_RESTORE | OCD_INITDATA )

Parameters

nNumObjs
[input] number of matrix objects to have in the matrix layer. use -1 to keep number of objects.
nNumRows
[input] number of rows each matrix object is to have. -1 to keep current.
nNumCols
[input] number of columns each matrix object is to have. -1 to keep current.
dwCntrl
[input] flags for specifying options (OC_const.h). default is OCD_RESTORE | OCD_INITDATA.

Return

TRUE for success, FALSE for failure

Examples

EX1

//Set the number of MatrixObjects in a matrix layer. 
void MatrixLayer_SetSize_Ex1()
{
    MatrixPage mp = Project.MatrixPages(0);
    if(!mp)
        return;
    
    MatrixLayer ml(mp.GetName());
    ml.SetSize();
}

Remark

See Also

vectorbase::SetSize, vectorbase::GetSize, Array::SetSize, Array::GetSize, Worksheet::SetSize

Header to Include

origin.h