2.2.4.27.4 MatrixLayer::Delete

Delete

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

Description

Delete a number of MatrixObjects from the matrix layer.

Syntax

BOOL Delete( int nPos, uint nNumObjs = 1 )

Parameters

nPos: [input] position for first matrix object to delete
nNumObjs: [input] number of matrix objects to delete. default is 1.

Return

TRUE on success and FALSE on failure.

Examples

EX1

//Delete a MatrixObject from the matrix layer. 
void MatrixLayer_Delete_Ex1()
{
    MatrixPage mp = Project.MatrixPages(0);
    if(!mp)
        return;
    
    MatrixLayer ml(mp.GetName());
    if( ml.Delete(1) )
        printf("Success to delete matrix object!");
    else
        printf("Fail to delete specified matrix object!");
}