2.2.4.46.13 Worksheet::DeleteRange

DeleteRange

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

Description

Delete a range of data in the worksheet

Syntax

BOOL DeleteRange( int nRowBegin, int nColBegin, int nRowEnd, int nColEnd, BOOL bInsertNotDelete = false, BOOL bUndo = false )

Parameters

nRowBegin: [input] Beginning row number (zero offset)
nColBegin: [input] Beginning column number (zero offset)
nRowEnd: [input] Ending row number (zero offset)
nColEnd: [input] Ending column number (zero offset)
bInsertNotDelete: [input] if TRUE then insert rows, False by default.
bUndo: [input] Whether to support Undo (TRUE) or not (FALSE)

Return

TRUE for success, otherwise FALSE

Examples

EX1

// Delete a range from a worksheet - rows after last deleted row move up in the worksheet
int Worksheet_DeleteRange_Ex1()
{
    WorksheetPage wp = Project.WorksheetPages(0);
    if(!wp)
        return -1;
    
    Worksheet wks(wp.GetName());
    return (int)wks.DeleteRange(0,0,4,1); // Delete five rows of first two columns
}