paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-22 20:39:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/grids. Adds content to the TCustomStringGrid.SaveColumns and TStringGridStrings topics.

Browse Source
This commit is contained in:
dsiders 2022-12-20 04:30:31 +00:00
parent 651303f114
commit d97d330495
1 changed files with 76 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/xml/lcl/grids.xml
View File

@ -8578,11 +8578,63 @@ its default value.
<element name="TCustomGrid.SaveColumns">
<short>
Saves column configuration, layout, and appearance values to an XML
configuration file.
Saves column configuration, layout, and appearance to an XML configuration
file.
</short>
<descr/>
<seealso/>
<descr>
<p>
<var>SaveColumns</var> is a method used to store information about columns on
the grid to the specified XML configuration file. It stores information about
the configuration, layout, and appearance of Columns defined for the grid,
including:
</p>
<ul>
<li>Columns.Count</li>
<li>Columns.Enabled</li>
</ul>
<p>
Information about each of the TGridColumn instances in Columns are written to
the XML configuration file, and includes the following:
</p>
<ul>
<li>TGridColumn.Index</li>
<li>TGridColumn.Width</li>
<li>TGridColumn.MinSize</li>
<li>TGridColumn.MaxSize</li>
<li>TGridColumn.Alignment</li>
<li>TGridColumn.Layout</li>
<li>TGridColumn.ButtonStyle</li>
<li>TGridColumn.Color</li>
<li>TGridColumn.ValueChecked</li>
<li>TGridColumn.ValueUnChecked</li>
<li>TGridColumn.PickList</li>
<li>TGridColumn.SizePriority</li>
<li>TGridColumn.Font</li>
<li>TGridColumn.Title.Caption</li>
<li>TGridColumn.Title.Font</li>
<li>TGridColumn.Title.Alignment</li>
<li>TGridColumn.Title.Color</li>
<li>TGridColumn.Title.Layout</li>
</ul>
<p>
SaveColumns calls the DoSaveColumn method for each of the columns to signal
the OnSaveColumn event handler (when assigned).
</p>
<p>
SaveColumns is called from the SaveContent method, and occurs when soDesign
has been included in the SaveOptions for the control and the Columns
collection has been enabled.
</p>
</descr>
<seealso>
<link id="TCustomGrid.Columns"/>
<link id="TCustomGrid.DoSaveColumn"/>
<link id="TCustomGrid.OnSaveColumn"/>
<link id="TCustomGrid.SaveContent"/>
<link id="TCustomGrid.SaveOptions"/>
<link id="TCGridColumn"/>
<link id="#lazutils.laz2_xmlcfg.TXMLConfig">TXMLConfig</link>
</seealso>
</element>
<element name="TCustomGrid.SaveColumns.cfg">
<short>XML configuration file where the values are written.</short>
@ -22586,11 +22638,17 @@ Represents strings used as the cell values in TCustomStringGrid / TStringGrid.
<descr>
<p>
<var>TStringGridStrings</var> is a <var>TStrings</var> descendant that
represents the strings used to populate the cells in a <var>TStringGrid</var>
instance.
implements the string container used to populate the cells in a
<var>TStringGrid</var> instance. A temporary TStringGridStrings instance is
created and used to store a new value assigned to the Cols or Rows property in
TStringGrid.
</p>
</descr>
<seealso/>
<seealso>
<link id="TCustomStringGrid.Cols"/>
<link id="TCustomStringGrid.Rows"/>
<link id="TStringGrid"/>
</seealso>
</element>
<!-- private -->
@ -22600,7 +22658,7 @@ instance.
<element name="TStringGridStrings.FIndex"/>
<element name="TStringGridStrings.FOwner"/>
<!-- private - but good to know -->
<!-- private -->
<element name="TStringGridStrings.ConvertIndexLineCol">
<short>
Converts an index position to line and column numbers for the Cells in a grid.