From cf23d4140bd1974305c8e1372f715941fb77509c Mon Sep 17 00:00:00 2001
From: dsiders
Date: Fri, 21 Feb 2025 16:39:27 -0500
Subject: [PATCH] Docs: LCL/dbgrids. Updates TCustomDBGrid, TComponentDataLink
topics for changes in 87877c4f. Issue #41451.
* TCustomDBGrid.EndLayout
* TComponentDataLink.DatasetScrolled
---
docs/xml/lcl/dbgrids.xml | 37 ++++++++++++++++++++++++++++++++-----
1 file changed, 32 insertions(+), 5 deletions(-)
diff --git a/docs/xml/lcl/dbgrids.xml b/docs/xml/lcl/dbgrids.xml
index 4be6ffa5d1..e245f89e8c 100644
--- a/docs/xml/lcl/dbgrids.xml
+++ b/docs/xml/lcl/dbgrids.xml
@@ -1485,15 +1485,41 @@ Signals the OnDataSetScrolled event handler when assigned.
DatasetScrolled is a procedure used to signal the
OnDataSetScrolled event handler when it has been assigned in the class
-instance.
+instance. DatasetScrolled is used in data sources or controls which change
+the active record for the linked Dataset. These classes can implement and
+assign a handler routine to perform actions specific to the control.
+
+TCustomDBGrid provides a default implementation for the OnDataSetScrolled
+event handler which performs the following control-specific actions:
+
+
+
+Updates scroll bar information (when needed).
+
+
+Resets the EditorMode for the control.
+
+
+Selects an Editor when the Active record has not been changed, and invalidates
+the control where the data link is used.
+
+
+Updates the active record and invalidates the grid row when the active record
+has been changed.
+
+
Restores EditorMode to the value on entry.
+
+
TDataLink.ActiveRecord
-Number of records for the event notification.
+
+Number of records for the event notification.
+
@@ -5148,7 +5174,8 @@ collection links to Fields in the associated dataset.
The grid maintains an internal counter that tracks the number of times
BeginLayout has been called to start a layout change for the control.
EndLayout decrements that counter, and when it reaches 0 (zero), the
-DoLayoutChanged method is called.
+private DoLayoutChanged method is called; scroll bar information is also
+updated in this method.
@@ -6080,7 +6107,7 @@ automatic columns.
LayoutChanged is a virtual procedure used to link Columns to the
Fields which read and write the values used in the control. LayoutChanged
calls the TDBGridColumns.LinkFields method establish the column-to-field
-association. If Columns have not been explicitly defined the
+association. If Columns have not been explicitly defined, the
AddAutomaticColumns method is called to add a column for each Field in the
linked dataset.
@@ -8146,4 +8173,4 @@ component palette in the Lazarus IDE, including:
-
+
\ No newline at end of file