Unit 'Grids' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#lcl]

TCustomStringGrid.Clean

Removes cell content using the specified options.

Declaration

Source position: grids.pas line 1775

public procedure TCustomStringGrid.Clean; overload;

procedure TCustomStringGrid.Clean(

  CleanOptions: TGridZoneSet

); overload;

procedure TCustomStringGrid.Clean(

  aRect: TRect;

  CleanOptions: TGridZoneSet

); overload;

procedure TCustomStringGrid.Clean(

  StartCol: Integer;

  StartRow: Integer;

  EndCol: Integer;

  EndRow: Integer;

  CleanOptions: TGridZoneSet

); overload;

Arguments

CleanOptions

  

Set with the grid zones affected in the method.

Arguments

aRect

  

Rectangle with the bounds for the affected cells.

CleanOptions

  

Set with the grid zones affected in the method.

Arguments

StartCol

  

Starting column number for the operation.

StartRow

  

Starting row number for the operation.

EndCol

  

Ending column number for the operation.

EndRow

  

Ending row number for the operation.

CleanOptions

  

Set with the grid zones affected in the method.

Description

Cleans all cells in the grid subject to the given CleanOptions, optionally specifying a range of cells or a rectangular region. See TGridZoneSet for more information.

The cleaning operation does not change the number of rows and columns. It replaces the content for the affected cells with empty strings ('').

Some examples: