Worksheet::DeleteSelection

DeleteSelection

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

Description

Deletes the current selection from a worksheet.Deletes the current selection from a worksheet.

Syntax

BOOL DeleteSelection( BOOL bUndo )

Parameters

bUndo: [input] Whether to support Undo (TRUE) or not (FALSE)

Return

FALSE if there is no selection, otherwise TRUE

Examples

EX1

// This example shows how to programmatically setup a 
// selection of alternate rows and delete those alternate
// rows in the active worksheet.
void del_alternate_rows(BOOL nUndo = 1)
{
        Worksheet wks = Project.ActiveLayer();
        
        int nRows = wks.GetNumRows();
        // generate array of row index to delete
        // alternate rows, so (0-offset) 1,3,5,7,..
        if(nRows > 0)
        {
                vector<int> nvAlternateRows;
                nvAlternateRows.Data(1, nRows-1, 2);
                wks.SetSelectedRange( nvAlternateRows );
                wks.DeleteSelection( nUndo );
        }
        else
                printf("empty worksheet, not enough rows to delete");
}