Docs: LCL/grids. Updates topics including:

* TCustomGrid.ClearRows
* TCustomGrid.Clear
* TCustomStringGrid.Clean
This commit is contained in:
dsiders 2023-03-11 21:40:13 +00:00
parent 6795a6dae5
commit 9095837756

View File

@ -19526,14 +19526,14 @@ Clears the cached fixed rows and row count values for the grid control.
</short> </short>
<descr> <descr>
<p> <p>
<var>ClearRows</var> is a <var>Boolean</var> function used to all rows in the <var>ClearRows</var> is a <var>Boolean</var> function used to remove all rows
grid control. This includes the fixed row for the control. The return value in the grid control. This includes the fixed row for the control. The return
is <b>True</b> if rows are successfully cleared in the method. It is value is <b>True</b> if rows are successfully cleared in the method. It is
<b>False</b> if the grid is already empty. <b>False</b> if the grid is already empty.
</p> </p>
<p> <p>
Sets EditorMode to <b>False</b> if a cell editor is visible on the grid ClearRows sets EditorMode to <b>False</b> if a cell editor is visible on the
control. Sets values in the FixedRows and and RowCount properties to 0 (zero). grid control. It sets values in the FixedRows and and RowCount properties to 0 (zero).
</p> </p>
<p> <p>
It does not change values in the FixedCols or ColCount properties. It does not change values in the FixedCols or ColCount properties.
@ -19541,7 +19541,9 @@ It does not change values in the FixedCols or ColCount properties.
</descr> </descr>
<seealso> <seealso>
<link id="TCustomGrid.RowCount"/> <link id="TCustomGrid.RowCount"/>
<link id="TCustomGrid.ColCount"/>
<link id="TCustomGrid.FixedRows"/> <link id="TCustomGrid.FixedRows"/>
<link id="TCustomGrid.FixedCols"/>
<link id="TCustomGrid.EditorMode"/> <link id="TCustomGrid.EditorMode"/>
<link id="TCustomGrid.Clear"/> <link id="TCustomGrid.Clear"/>
</seealso> </seealso>
@ -19581,10 +19583,18 @@ to RowCount or ColCount values.
Compatibility: This applies to Lazarus grids only; under Delphi/Kylix a grid Compatibility: This applies to Lazarus grids only; under Delphi/Kylix a grid
cannot be completely emptied. cannot be completely emptied.
</p> </p>
<p>
Use FixedRows, FixedCols, RowCount, and ColCount to specify the number of rows
or columns on the grid.
</p>
</descr> </descr>
<seealso> <seealso>
<link id="TCustomGrid.ClearCols"/> <link id="TCustomGrid.ClearCols"/>
<link id="TCustomGrid.ClearRows"/> <link id="TCustomGrid.ClearRows"/>
<link id="TCustomGrid.RowCount"/>
<link id="TCustomGrid.ColCount"/>
<link id="TCustomGrid.FixedCols"/>
<link id="TCustomGrid.FixedRows"/>
<link id="TCustomGrid.EditorMode"/> <link id="TCustomGrid.EditorMode"/>
<link id="TCustomGrid.VisualChange"/> <link id="TCustomGrid.VisualChange"/>
<link id="TCustomGrid.SizeChanged"/> <link id="TCustomGrid.SizeChanged"/>
@ -24040,7 +24050,9 @@ control.
</element> </element>
<element name="TCustomStringGrid.Clean"> <element name="TCustomStringGrid.Clean">
<short>Removes cell content using the specified options.</short> <short>
Removes cell content which match the specified options.
</short>
<descr> <descr>
<p> <p>
Cleans all cells in the grid subject to the given <var>CleanOptions</var>, Cleans all cells in the grid subject to the given <var>CleanOptions</var>,
@ -24075,8 +24087,24 @@ text
<b>Clean all cells except fixed grid columns:</b> <b>Clean all cells except fixed grid columns:</b>
</p> </p>
<code> <code>
// leaves cell content in fixed columns
grid.Clean([gzNormal, gzFixedRows]); grid.Clean([gzNormal, gzFixedRows]);
</code> </code>
<p>
<b>Clean non-fixed cells in a rectangular region:</b>
</p>
<code>
// 4x3 cell area after fixed columns and rows
grid.Clean(grid.FixedCols, grid.FixedRows, grid.FixedCols+3,
grid.FixedRols+2, [gzNormal])
</code>
<p>
Use Clear to remove all columns and rows on the grid.
</p>
<p>
Use ColCount, FixedCols, RowCount, and FixedRows to adjust the number of
columns or rows for the specific types.
</p>
</descr> </descr>
<seealso/> <seealso/>
</element> </element>