mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-08-15 16:59:49 +02:00
Docs: LCL/dbgrids. Removes extra spaces in topics. Updates tagging for True and False values.
This commit is contained in:
dsiders
parent
ff41e924a1
commit
2deb16f384
@ -181,7 +181,7 @@
|
||||
</element>
|
||||
<element name="TDBGridOption.dgDisableDelete">
|
||||
<short>
|
||||
Indicates if deleting records with <var><b>Ctrl + Delete</b></var> is disabled.
|
||||
Indicates if deleting records with <b>Ctrl+Delete</b> is disabled.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TDBGridOption.dgDisableInsert">
|
||||
@ -687,16 +687,16 @@
|
||||
<var>MoveNext</var> is a Boolean function used to move the enumerator to the next item in the bookmark list. Move next increments the value in BookmarkIndex, and examines the Options property to see if any actions are required, such as: setting the value of the Current Bookmark before navigation, or disabling controls attached to the dataset.
|
||||
</p>
|
||||
<p>
|
||||
MoveNext updates the current bookmark and checks the dataset to see if the bookmark is still valid. The return value is False if the record for the bookmark no longer exists in the dataset and Options indicates the enumerator should halt for an invalid bookmark. False is also returned when the value in BookmarkIndex exceeds the number of items in the BookmarkList.
|
||||
MoveNext updates the current bookmark and checks the dataset to see if the bookmark is still valid. The return value is <b>False</b> if the record for the bookmark no longer exists in the dataset and Options indicates the enumerator should halt for an invalid bookmark. <b>False</b> is also returned when the value in BookmarkIndex exceeds the number of items in the BookmarkList.
|
||||
</p>
|
||||
<p>
|
||||
The return value is True when the action has been performed successfully.
|
||||
The return value is <b>True</b> when the action has been performed successfully.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TBookmarkedRecordEnumerator.MoveNext.Result">
|
||||
<short>True when the action has been performed successfully.</short>
|
||||
<short><b>True</b> when the action has been performed successfully.</short>
|
||||
</element>
|
||||
|
||||
<element name="TBookmarkedRecordEnumerator.GetEnumerator">
|
||||
@ -790,7 +790,7 @@
|
||||
<var>GetCurrentRowSelected</var> is a <var>Boolean</var> function used to get the value for the <var>CurrentRowSelected</var> property. GetCurrentRowSelected calls the CheckActive method to ensure that the Dataset for the list is properly configured. See CheckActive for more information.
|
||||
</p>
|
||||
<p>
|
||||
The return value is True when a TBookmark instance for the current row already exists in the list.
|
||||
The return value is <b>True</b> when a TBookmark instance for the current row already exists in the list.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -798,7 +798,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TBookmarkList.GetCurrentRowSelected.Result">
|
||||
<short>True when a bookmark for the current row already exists in the list.</short>
|
||||
<short><b>True</b> when a bookmark for the current row already exists in the list.</short>
|
||||
</element>
|
||||
|
||||
<element name="TBookmarkList.GetItem">
|
||||
@ -825,14 +825,14 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetCurrentRowSelected</var> is a procedure which provides write access for the CurrentRowSelected property. SetCurrentRowSelected gets a bookmark for the current row, and calls Find to determine if the bookmark already exists in the list. When AValue contains False, an existing bookmark is freed and removed from the bookmark list. A Bookmark not in the list is created and added when AValue is True.
|
||||
<var>SetCurrentRowSelected</var> is a procedure which provides write access for the CurrentRowSelected property. SetCurrentRowSelected gets a bookmark for the current row, and calls Find to determine if the bookmark already exists in the list. When AValue contains <b>False</b>, an existing bookmark is freed and removed from the bookmark list. A Bookmark not in the list is created and added when AValue is <b>True</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TBookmarkList.SetCurrentRowSelected.AValue">
|
||||
<short>
|
||||
True to select the current row. False to de-selected the current row.
|
||||
<b>True</b> to select the current row. <b>False</b> to de-selected the current row.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
@ -942,7 +942,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TBookmarkList.Find.Result">
|
||||
<short>True when the bookmark is located in the list.</short>
|
||||
<short><b>True</b> when the bookmark is located in the list.</short>
|
||||
</element>
|
||||
<element name="TBookmarkList.Find.Item">
|
||||
<short>Bookmark to locate.</short>
|
||||
@ -975,14 +975,14 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Refresh</var> searches for and removes invalid Bookmarks in the list. The return value is True if an invalid TBookmark instance was found and removed in the method; it also indicates that the Invalidate method in the associated Grid control was called prior to exiting from the method.
|
||||
<var>Refresh</var> searches for and removes invalid Bookmarks in the list. The return value is <b>True</b> if an invalid TBookmark instance was found and removed in the method; it also indicates that the Invalidate method in the associated Grid control was called prior to exiting from the method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TBookmarkList.Refresh.Result">
|
||||
<short>
|
||||
True when the bookmark list was updated and the grid was refreshed.
|
||||
<b>True</b> when the bookmark list was updated and the grid was refreshed.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
@ -1195,10 +1195,10 @@
|
||||
<var>ActiveChanged</var> is a procedure used to call event handlers when the value in Active is changed.
|
||||
</p>
|
||||
<p>
|
||||
When Active contains True, the Dataset for the class is read and compared to the value in the DatasetName property. When it differs from the stored value the change is for a new dataset, and the OnNewDataset event handler is signalled. If DatasetName is the same as the stored value, the OnDataseOpen event handler is signalled.
|
||||
When Active contains <b>True</b>, the Dataset for the class is read and compared to the value in the DatasetName property. When it differs from the stored value the change is for a new dataset, and the OnNewDataset event handler is signalled. If DatasetName is the same as the stored value, the OnDataseOpen event handler is signalled.
|
||||
</p>
|
||||
<p>
|
||||
When Active contains False, the Datasource and Dataset are checked to ensure that the contain valid class instances. If Datasource is unassigned, the OnInvalidDataSource event handler is signalled. If Dataset is unassigned, the Dataset is being freed, and the OnInvalidDataSet event handler is signalled. If Dataset is assigned, the dataset has been closed and the OnDataSetClose event handler is signalled.
|
||||
When Active contains <b>False</b>, the Datasource and Dataset are checked to ensure that the contain valid class instances. If Datasource is unassigned, the OnInvalidDataSource event handler is signalled. If Dataset is unassigned, the Dataset is being freed, and the OnInvalidDataSet event handler is signalled. If Dataset is assigned, the dataset has been closed and the OnDataSetClose event handler is signalled.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -1608,7 +1608,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetIsDesignColumn</var> is a Boolean function used to get the value for the IsDesignColumn property. The return value is True when DesignIndex contains a value in the range <var>0..9999</var>.
|
||||
<var>GetIsDesignColumn</var> is a Boolean function used to get the value for the IsDesignColumn property. The return value is <b>True</b> when DesignIndex contains a value in the range <var>0..9999</var>.
|
||||
</p>
|
||||
<p>
|
||||
The upper range for DesignIndex is a result of the value assigned in Create. The value <var>10000</var> is used in the property when Grid has not assigned for the collection, or Grid includes csLoading in its ComponentState property.
|
||||
@ -1633,14 +1633,14 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>IsDisplayFormatStored</var> is a Boolean function used as the storage specifier for the DisplayFormat property. The return value is True if the member variable for the DisplayFormat property is different than the one used for the Field.
|
||||
<var>IsDisplayFormatStored</var> is a Boolean function used as the storage specifier for the DisplayFormat property. The return value is <b>True</b> if the member variable for the DisplayFormat property is different than the one used for the Field.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TColumn.IsDisplayFormatStored.Result">
|
||||
<short>
|
||||
True when DisplayFormat is different the one used for the Field.
|
||||
<b>True</b> when DisplayFormat is different the one used for the Field.
|
||||
</short>
|
||||
<descr></descr>
|
||||
<seealso></seealso>
|
||||
@ -1804,7 +1804,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetDefaultVisible</var> is an overridden Boolean function that indicates if the Field for the column is Visible. GetDefaultVisible uses Field to get its Visible property for use as the return value in the method. If Field has not been assigned in the column, the return value is True.
|
||||
<var>GetDefaultVisible</var> is an overridden Boolean function that indicates if the Field for the column is Visible. GetDefaultVisible uses Field to get its Visible property for use as the return value in the method. If Field has not been assigned in the column, the return value is <b>True</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -1812,7 +1812,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TColumn.GetDefaultVisible.Result">
|
||||
<short>True when the Field for the column is visible.</short>
|
||||
<short><b>True</b> when the Field for the column is visible.</short>
|
||||
</element>
|
||||
|
||||
<element name="TColumn.GetDisplayName">
|
||||
@ -1845,7 +1845,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetDefaultReadOnly</var> is an overridden Boolean function which gets the default value for the ReadOnly property. GetDefaultReadOnly combines the ReadOnly values found in both the Grid and the Field for the dataset to derive the value for the method. The return value is True when Grid or Field is not assigned for the column.
|
||||
<var>GetDefaultReadOnly</var> is an overridden Boolean function which gets the default value for the ReadOnly property. GetDefaultReadOnly combines the ReadOnly values found in both the Grid and the Field for the dataset to derive the value for the method. The return value is <b>True</b> when Grid or Field is not assigned for the column.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -2009,7 +2009,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>IsDefault</var> is an overridden Boolean function that indicates if the column uses its default display format. The return value is True when the value in the DisplayFormat property has not been changed. IsDefault calls the inherited method to get the return value for the method.
|
||||
<var>IsDefault</var> is an overridden Boolean function that indicates if the column uses its default display format. The return value is <b>True</b> when the value in the DisplayFormat property has not been changed. IsDefault calls the inherited method to get the return value for the method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -2017,7 +2017,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TColumn.IsDefault.Result">
|
||||
<short>True when DisplayFormat has been changed.</short>
|
||||
<short><b>True</b> when DisplayFormat has been changed.</short>
|
||||
</element>
|
||||
|
||||
<element name="TColumn.DesignIndex">
|
||||
@ -2206,7 +2206,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HasAutomaticColumns</var> is a Boolean function that indicates if any items in the collection are an automatic column added at run-time. Automatic columns are a feature in TDBGrid enabled by adding the appropriate value to its OptionsExtra property. HasAutomaticColumns returns True if a TColumn instance in the Items property has its IsAutomaticColumn property set.
|
||||
<var>HasAutomaticColumns</var> is a Boolean function that indicates if any items in the collection are an automatic column added at run-time. Automatic columns are a feature in TDBGrid enabled by adding the appropriate value to its OptionsExtra property. HasAutomaticColumns returns <b>True</b> if a TColumn instance in the Items property has its IsAutomaticColumn property set.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -2215,7 +2215,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDBGridColumns.HasAutomaticColumns.Result">
|
||||
<short>True when automatic columns are stored in the collection.</short>
|
||||
<short><b>True</b> when automatic columns are stored in the collection.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDBGridColumns.HasDesignColumns">
|
||||
@ -2224,7 +2224,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HasDesignColumns</var> is a Boolean function that indicates if the collection contains any items explicitly added at design-time. HasDesignColumns returns True if Items contains a TColumn instance with its IsDesignColumn property set.
|
||||
<var>HasDesignColumns</var> is a Boolean function that indicates if the collection contains any items explicitly added at design-time. HasDesignColumns returns <b>True</b> if Items contains a TColumn instance with its IsDesignColumn property set.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -2234,7 +2234,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TDBGridColumns.HasDesignColumns.Result">
|
||||
<short>True an item has its IsDesignColumn property set.</short>
|
||||
<short><b>True</b> an item has its IsDesignColumn property set.</short>
|
||||
</element>
|
||||
|
||||
<element name="TDBGridColumns.RemoveAutoColumns">
|
||||
@ -2246,7 +2246,7 @@
|
||||
<var>RemoveAutoColumns</var> is a procedure used to remove any automatic columns in the collection. RemoveAutoColumns uses HasAutomaticColumns to determine if any action is required.
|
||||
</p>
|
||||
<p>
|
||||
When HasAutomaticColumns returns True the Grid updates its GridStatus to include the value gsRemovingAutoColumns. RemoveAutoColumns calls the Delete method for any column having its IsAutomaticColumn property set to True. gsRemovingAutoColumns is removed from the GridStatus property in the Grid prior to exiting from the method.
|
||||
When HasAutomaticColumns returns <b>True</b> the Grid updates its GridStatus to include the value gsRemovingAutoColumns. RemoveAutoColumns calls the Delete method for any column having its IsAutomaticColumn property set to <b>True</b>. gsRemovingAutoColumns is removed from the GridStatus property in the Grid prior to exiting from the method.
|
||||
</p>
|
||||
<p>
|
||||
Applications do not normally call the RemoveAutoColumns method. Use OptionsExtra in TDBGrid to disable the automatic columns feature for the grid control.
|
||||
@ -2906,7 +2906,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateBufferCount</var> is a procedure used to set the number of records buffered for the linked dataset. UpdateBufferCount requires that DataLink be marked as Active to set the buffer count. If DataLink.Active contains False, no actions are performed in the method.
|
||||
<var>UpdateBufferCount</var> is a procedure used to set the number of records buffered for the linked dataset. UpdateBufferCount requires that DataLink be marked as Active to set the buffer count. If DataLink.Active contains <b>False</b>, no actions are performed in the method.
|
||||
</p>
|
||||
<p>
|
||||
UpdateBufferCount calls GetBufferCount to determine the number of rows that can be displayed in the control with the DefaultRowHeight. When Options includes the value dgTitles, the buffer count is decreased by 1 to account for the fixed title row. UpdateBufferCount stores the new value in the BufferCount property in DataLink.
|
||||
@ -2960,7 +2960,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateGridColumnSizes</var> is a procedure used to update the sizes for automatically sized columns in the grid control. UpdateGridColumnSizes requires DefaultColWidths to be in use for the grid. No actions are performed in the method when DefaultColWidths contains False.
|
||||
<var>UpdateGridColumnSizes</var> is a procedure used to update the sizes for automatically sized columns in the grid control. UpdateGridColumnSizes requires DefaultColWidths to be in use for the grid. No actions are performed in the method when DefaultColWidths contains <b>False</b>.
|
||||
</p>
|
||||
<p>
|
||||
UpdateGridColumnSizes also requires the Options property to include the value dgAutoSizeColumns which enables the auto-sized columns feature. No actions are performed if the feature has not been enable for the grid control.
|
||||
@ -3004,7 +3004,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>RestoreEditor</var> is a procedure used to re-enable the editor control in the grid after processing scrollbar messages. RestoreEditor is used when EditorMode contains True. No actions are performed in the method when EditorMode contains False. RestoreEditor toggles the value in EditorMode to force the editor to be refreshed and redrawn.
|
||||
<var>RestoreEditor</var> is a procedure used to re-enable the editor control in the grid after processing scrollbar messages. RestoreEditor is used when EditorMode contains <b>True</b>. No actions are performed in the method when EditorMode contains <b>False</b>. RestoreEditor toggles the value in EditorMode to force the editor to be refreshed and redrawn.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -3016,7 +3016,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ISEOF</var> is a Boolean function used to indicate if the linked dataset is positioned at the end-of-file. ISEOF uses the DataLink for the control to access its Active and Dataset properties. DataLink must be Active (contains True) to access its Dataset. The return value is True when the TDataset.EOF method returns True. The return value is False when DataLink is not Active, or TDataset.EOF returns False.
|
||||
<var>ISEOF</var> is a Boolean function used to indicate if the linked dataset is positioned at the end-of-file. ISEOF uses the DataLink for the control to access its Active and Dataset properties. DataLink must be Active (contains <b>True</b>) to access its Dataset. The return value is <b>True</b> when the TDataset.EOF method returns <b>True</b>. The return value is <b>False</b> when DataLink is not Active, or TDataset.EOF returns <b>False</b>.
|
||||
</p>
|
||||
<p>
|
||||
ISEOF is used in the KeyDown and MouseDown methods.
|
||||
@ -3034,7 +3034,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
ValidDataSet is a Boolean function used to indicate if the DataLink for the control contains a valid and active Dataset. The return value is True when DataLink has a Dataset assigned to the property, and it has been marked as Active.
|
||||
ValidDataSet is a Boolean function used to indicate if the DataLink for the control contains a valid and active Dataset. The return value is <b>True</b> when DataLink has a Dataset assigned to the property, and it has been marked as Active.
|
||||
</p>
|
||||
<p>
|
||||
ValidDataSet is used in the implementation of various methods including KeyDown, MouseDown, and DoExit.
|
||||
@ -3043,7 +3043,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.ValidDataset.Result">
|
||||
<short>True when the control points to a valid dataset.</short>
|
||||
<short><b>True</b> when the control points to a valid dataset.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.InsertCancelable">
|
||||
@ -3052,7 +3052,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
InsertCancelable is a Boolean function that indicates if the dataset for the control can cancel an active insert operation. InsertCancelable uses the DataSet in DataLink to ensure that the State contains dsInsert. The return value is False if DataSet state has any value other than dsInsert. InsertCancelable also examines both DataSet and DataLink to see if either of their Modified properties has been set. The return value is False when either has been modified.
|
||||
InsertCancelable is a Boolean function that indicates if the dataset for the control can cancel an active insert operation. InsertCancelable uses the DataSet in DataLink to ensure that the State contains dsInsert. The return value is <b>False</b> if DataSet state has any value other than dsInsert. InsertCancelable also examines both DataSet and DataLink to see if either of their Modified properties has been set. The return value is <b>False</b> when either has been modified.
|
||||
</p>
|
||||
<p>
|
||||
InsertCancelable is used in the implementation of methods like KeyDown, MouseDown, and DoExit.
|
||||
@ -3061,7 +3061,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.InsertCancelable.Result">
|
||||
<short>True when the insert can be cancelled.</short>
|
||||
<short><b>True</b> when the insert can be cancelled.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.StartUpdating">
|
||||
@ -3070,7 +3070,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
StartUpdating is a procedure used to prepare the grid control for updates to its display area. StartUpdating checks the value from UpdatingData to see if the procedure has already been called. No actions are performed in the method when UpdatingData returns True.
|
||||
StartUpdating is a procedure used to prepare the grid control for updates to its display area. StartUpdating checks the value from UpdatingData to see if the procedure has already been called. No actions are performed in the method when UpdatingData returns <b>True</b>.
|
||||
</p>
|
||||
<p>
|
||||
StartUpdating updates the GridStatus property to include the value gsUpdatingData. The value in the ControlStyle property is also updated to include the value csActionClient. Finally, the LockEditor method is called to prevent changes in the editor control while the update is in progress.
|
||||
@ -3103,13 +3103,13 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
UpdatingData is a Boolean function that indicates if the UpdateData method has already been called for the grid control. UpdatingData returns True if the GridStatus property contains the value gsUpdatingData. The GridStatus value is added in the StartUpdating method. UpdatingData prevents multiple calls to UpdateData.
|
||||
UpdatingData is a Boolean function that indicates if the UpdateData method has already been called for the grid control. UpdatingData returns <b>True</b> if the GridStatus property contains the value gsUpdatingData. The GridStatus value is added in the StartUpdating method. UpdatingData prevents multiple calls to UpdateData.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.UpdatingData.Result">
|
||||
<short>True when UpdateData has been called for the control.</short>
|
||||
<short><b>True</b> when UpdateData has been called for the control.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.SwapCheckBox">
|
||||
@ -3147,7 +3147,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.SelectRecord.AValue">
|
||||
<short>True when the current record should be selected.</short>
|
||||
<short><b>True</b> when the current record should be selected.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.GetScrollbarParams">
|
||||
@ -3249,7 +3249,7 @@
|
||||
AddAutomaticColumns is enabled by including the value dgeAutoColumns in the OptionsExtra property. No actions are performed in the method when the feature has not been included in the OptionsExtra property.
|
||||
</p>
|
||||
<p>
|
||||
AddAutomaticColumns uses DataLink to get the Fields for the dataset, and checks the Columns collection to see if a column already exists for each Field. If the Field is already in the collection, it is skipped to avoid duplicate Fields. Missing Fields are added to Columns using its Add method, and sets the IsAutomaticColumn and Visible properties to True for each. When missing Fields have been added, the ResetColumnsOrder method in Columns is called using the coFieldIndexOrder column ordering option.
|
||||
AddAutomaticColumns uses DataLink to get the Fields for the dataset, and checks the Columns collection to see if a column already exists for each Field. If the Field is already in the collection, it is skipped to avoid duplicate Fields. Missing Fields are added to Columns using its Add method, and sets the IsAutomaticColumn and Visible properties to <b>True</b> for each. When missing Fields have been added, the ResetColumnsOrder method in Columns is called using the coFieldIndexOrder column ordering option.
|
||||
</p>
|
||||
<p>
|
||||
AddAutomaticColumns updates the GridStatus property prior to adding columns to include the value gsAddingAutoColumns. The value is removed from GridStatus when adding columns has completed. This prevents the TDBGridColumns.Add method from removing automatic columns while the add operation is still active.
|
||||
@ -3375,7 +3375,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>CheckDisplayMemo</var> is a Boolean function used to determine if the specified field is a Memo field that needs to be displayed in the grid control. The return value is True when the specified field has the value ftMemo in its DataType property, and the Options property includes the value dgDisplayMemoText.
|
||||
<var>CheckDisplayMemo</var> is a Boolean function used to determine if the specified field is a Memo field that needs to be displayed in the grid control. The return value is <b>True</b> when the specified field has the value ftMemo in its DataType property, and the Options property includes the value dgDisplayMemoText.
|
||||
</p>
|
||||
<p>
|
||||
CheckDisplayMemo is called from various methods which measure or render the content for the grid, including:
|
||||
@ -3399,7 +3399,7 @@
|
||||
</element>
|
||||
<element name="TCustomDBGrid.CheckDisplayMemo.Result">
|
||||
<short>
|
||||
True if the field is a memo field type and the display memo text option is enabled.
|
||||
<b>True</b> if the field is a memo field type and the display memo text option is enabled.
|
||||
</short>
|
||||
</element>
|
||||
|
||||
@ -3421,7 +3421,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ColRowMoved</var> is an overridden procedure used to signal event handlers when a row or a column is moved in the grid control. When IsColumn contains False, the OnRowMoved event handler is signalled (when assigned). When IsColumn contains True, the OnColumnMoved event handler is signalled (when assigned) if Columns have not been Enabled in the grid control. If Columns have been Enabled, the inherited ColRowMoved method is called.
|
||||
<var>ColRowMoved</var> is an overridden procedure used to signal event handlers when a row or a column is moved in the grid control. When IsColumn contains <b>False</b>, the OnRowMoved event handler is signalled (when assigned). When IsColumn contains <b>True</b>, the OnColumnMoved event handler is signalled (when assigned) if Columns have not been Enabled in the grid control. If Columns have been Enabled, the inherited ColRowMoved method is called.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -3604,7 +3604,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoMouseWheelDown</var> is an overridden Boolean function used to handle mouse wheel down events in the grid control. The return value is True when the mouse wheel event has been handled in the method. DoMouseWheelDown signals the OnMouseWheelDown event handler when it has been assigned to handle the mouse event. If OnMouseWheelDown cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
|
||||
<var>DoMouseWheelDown</var> is an overridden Boolean function used to handle mouse wheel down events in the grid control. The return value is <b>True</b> when the mouse wheel event has been handled in the method. DoMouseWheelDown signals the OnMouseWheelDown event handler when it has been assigned to handle the mouse event. If OnMouseWheelDown cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -3612,7 +3612,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.DoMouseWheelDown.Result">
|
||||
<short>True when the mouse event is handled in the method.</short>
|
||||
<short><b>True</b> when the mouse event is handled in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.DoMouseWheelDown.Shift">
|
||||
<short>Shift state for the mouse wheel event.</short>
|
||||
@ -3627,13 +3627,13 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoMouseWheelUp</var> is an overridden Boolean function used to handle mouse wheel up events in the grid control. The return value is True when the mouse wheel event has been handled in the method. DoMouseWheelUp signals the OnMouseWheelUp event handler when it has been assigned to handle the mouse event. If OnMouseWheelUp cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
|
||||
<var>DoMouseWheelUp</var> is an overridden Boolean function used to handle mouse wheel up events in the grid control. The return value is <b>True</b> when the mouse wheel event has been handled in the method. DoMouseWheelUp signals the OnMouseWheelUp event handler when it has been assigned to handle the mouse event. If OnMouseWheelUp cannot handle the mouse event, and the DataLink is marked as Active, DataLink calls its MoveBy method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.DoMouseWheelUp.Result">
|
||||
<short>True when the mouse event is handled in the method.</short>
|
||||
<short><b>True</b> when the mouse event is handled in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.DoMouseWheelUp.Shift">
|
||||
<short>Shift state for the mouse wheel event.</short>
|
||||
@ -3658,7 +3658,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>DoPrepareCanvas</var> is an overridden procedure used to prepare the Canvas to draw a cell in the grid control. DoPrepareCanvas applies to data cells and performs no actions in the method when aRow refers to a fixed row in the control. In addition, DoPrepareCanvas applies only when DefaultDrawing contains False. No actions are performed in the method when DefaultDrawing is enabled.
|
||||
<var>DoPrepareCanvas</var> is an overridden procedure used to prepare the Canvas to draw a cell in the grid control. DoPrepareCanvas applies to data cells and performs no actions in the method when aRow refers to a fixed row in the control. In addition, DoPrepareCanvas applies only when DefaultDrawing contains <b>False</b>. No actions are performed in the method when DefaultDrawing is enabled.
|
||||
</p>
|
||||
<p>
|
||||
DoPrepareCanvas calls GetSelectedState to determine if the Canvas is updated with brush and font colors used to draw in the specified state. DoPrepareCanvas signals the OnPrepareCanvas event handler (when assigned) using the specified column number and drawing state.
|
||||
@ -3974,7 +3974,7 @@
|
||||
<var>EditingColumn</var> is a procedure used to set or reset the column being edited in the control .
|
||||
</p>
|
||||
<p>
|
||||
aCol indicates the ordinal column number and is stored internally for use in other methods of the control. Ok indicates that editing is active when set and causes the DataLink to set its Modified flag to true. When Ok contains False the internal column number is reset to its default value indicating that no column is currently being edited.
|
||||
aCol indicates the ordinal column number and is stored internally for use in other methods of the control. Ok indicates that editing is active when set and causes the DataLink to set its Modified flag to <b>True</b>. When Ok contains <b>False</b> the internal column number is reset to its default value indicating that no column is currently being edited.
|
||||
</p>
|
||||
<p>
|
||||
EditingColumn is used in the implementation of other methods in the grid control such as UpdateData, EditorCancelEditing, EditorIsReadOnly, and DoExit.
|
||||
@ -4038,7 +4038,7 @@
|
||||
<descr>
|
||||
<p>
|
||||
<var>EditorCanAcceptKey</var> is an overridden Boolean function
|
||||
which determines if the cell editor can accept the character specified in <var>ch</var>. EditorCanAcceptKey requires that the linked dataset be active to access the SelectedField for the control. The Field cannot be an AutoIncrement, Lookup, Calculated, or Blob Field type. The return value is False if any of these conditions are not satisfied.
|
||||
which determines if the cell editor can accept the character specified in <var>ch</var>. EditorCanAcceptKey requires that the linked dataset be active to access the SelectedField for the control. The Field cannot be an AutoIncrement, Lookup, Calculated, or Blob Field type. The return value is <b>False</b> if any of these conditions are not satisfied.
|
||||
</p>
|
||||
<p>
|
||||
EditorCanAcceptKey calls the IsValidChar routine to determine if the UTF8-encoded value in ch can be applied to the dataset for the control.
|
||||
@ -4052,7 +4052,7 @@
|
||||
<short>Key to examine in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.EditorCanAcceptKey.Result">
|
||||
<short>True when the character can be applied to the field.</short>
|
||||
<short><b>True</b> when the character can be applied to the field.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.EditorIsReadOnly">
|
||||
@ -4065,7 +4065,7 @@
|
||||
editor can be enabled for the selected cell in the control.
|
||||
</p>
|
||||
<p>
|
||||
EditorIsReadOnly calls the inherited method to ensure that requirements from the ancestor class are respected. If the ancestor class returns True no actions are performed in the method.
|
||||
EditorIsReadOnly calls the inherited method to ensure that requirements from the ancestor class are respected. If the ancestor class returns <b>True</b> no actions are performed in the method.
|
||||
</p>
|
||||
<p>
|
||||
EditorIsReadOnly locates the TField used to store data for the selected cell, and calls its CanModify method to determine if the Field can be modified. Additional logic is applied for lookup Fields; the TField.KeyFields for the Field are also examined to determine if any of them are marked as read-only.
|
||||
@ -4082,7 +4082,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.EditorIsReadOnly.Result">
|
||||
<short>True when an editor cannot modify the select cell.</short>
|
||||
<short><b>True</b> when an editor cannot modify the select cell.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.EditorTextChanged">
|
||||
@ -4238,7 +4238,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.GetDefaultColumnReadOnly.Result">
|
||||
<short>True when the column cannot be modified.</short>
|
||||
<short><b>True</b> when the column cannot be modified.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.GetDefaultColumnReadOnly.Column">
|
||||
<short>Column number to examine.</short>
|
||||
@ -4428,7 +4428,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetIsCellSelected</var> is an overridden Boolean function used to determine if the cell at the specified location is currently selected. GetIsCellSelected calls the inherited method to get the return value, and also examines the value in DrawingMultiSelRecord. The return value is True when the cell is either selected or multi-selected (when enabled).
|
||||
<var>GetIsCellSelected</var> is an overridden Boolean function used to determine if the cell at the specified location is currently selected. GetIsCellSelected calls the inherited method to get the return value, and also examines the value in DrawingMultiSelRecord. The return value is <b>True</b> when the cell is either selected or multi-selected (when enabled).
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -4436,7 +4436,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.GetIsCellSelected.Result">
|
||||
<short>True when the specified cell is selected or multi-selected.</short>
|
||||
<short><b>True</b> when the specified cell is selected or multi-selected.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.GetIsCellSelected.aCol">
|
||||
<short>Column number to examine.</short>
|
||||
@ -4519,7 +4519,7 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.GridCanModify.Result">
|
||||
<short>True when the grid can be modified.</short>
|
||||
<short><b>True</b> when the grid can be modified.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.GetSBVisibility">
|
||||
@ -4528,7 +4528,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
GetSBVisibility is an overridden procedure used to determine the visibility of horizontal and vertical scroll bars for the control. GetSBVisibility calls the inherited method to use the logic implemented in the ancestor class. GetSBVisibility overrides the value used for the vertical scroll bar; it is set to True when ScrollBars contains ssVertical or ssBoth. ScrollBarAutomatic is called when the vertical scroll bar is not visible, and the GetScrollbarParams method is used to update the vertical scrollbar settings.
|
||||
GetSBVisibility is an overridden procedure used to determine the visibility of horizontal and vertical scroll bars for the control. GetSBVisibility calls the inherited method to use the logic implemented in the ancestor class. GetSBVisibility overrides the value used for the vertical scroll bar; it is set to <b>True</b> when ScrollBars contains ssVertical or ssBoth. ScrollBarAutomatic is called when the vertical scroll bar is not visible, and the GetScrollbarParams method is used to update the vertical scrollbar settings.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -4592,10 +4592,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HeaderSized</var> is an overridden procedure which updates the Columns for the control when a header cell is resized. If IsColumn contains False the resize operation was for the height of a header row and no action is performed in the method. When IsColumn contains True the request applies to the width of the column with the Field at the position specified in Index.
|
||||
<var>HeaderSized</var> is an overridden procedure which updates the Columns for the control when a header cell is resized. If IsColumn contains <b>False</b> the resize operation was for the height of a header row and no action is performed in the method. When IsColumn contains <b>True</b> the request applies to the width of the column with the Field at the position specified in Index.
|
||||
</p>
|
||||
<p>
|
||||
HeaderSized calls the ColumnIndexFromGridColumn method to determine the position in the Columns collection for the Field specified in Index. The width in Columns is updated with the corresponding value from ColWidths. HeaderSized sets the value in DefaultColWidths to False to indicate that custom column sizing has been applied to the control.
|
||||
HeaderSized calls the ColumnIndexFromGridColumn method to determine the position in the Columns collection for the Field specified in Index. The width in Columns is updated with the corresponding value from ColWidths. HeaderSized sets the value in DefaultColWidths to <b>False</b> to indicate that custom column sizing has been applied to the control.
|
||||
</p>
|
||||
<p>
|
||||
HeaderSized signals the OnColumnSized event handler when assigned for the control.
|
||||
@ -4638,7 +4638,7 @@
|
||||
Please note that TField does not contain a method which verifies a Unicode character. This routine converts a multi-byte Unicode character using UTF8ToSys and calls the TField.IsValidChar method to validate.
|
||||
</p>
|
||||
<p>
|
||||
IsValidChar returns True when TField.IsValidChar returns the same or when AChar contains the <var>BackSace (Decimal 8)</var> character.
|
||||
IsValidChar returns <b>True</b> when TField.IsValidChar returns the same or when AChar contains the <var>BackSace (Decimal 8)</var> character.
|
||||
</p>
|
||||
</descr>
|
||||
</element>
|
||||
@ -4751,16 +4751,16 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>LinkActive</var> is a procedure which updates the control when the state of its DataLink is changing. Value contains False when the dataset for the DataLink will be closed. The state change causes updates to other control properties like SelectedRows which tracks the selected rows in the linked dataset. LinkActive calls RemoveAutomaticColumns to remove automatic columns added to the control when the DataLink became active. The LayoutChanged method is called to refresh the control after updates to the Columns property.
|
||||
<var>LinkActive</var> is a procedure which updates the control when the state of its DataLink is changing. Value contains <b>False</b> when the dataset for the DataLink will be closed. The state change causes updates to other control properties like SelectedRows which tracks the selected rows in the linked dataset. LinkActive calls RemoveAutomaticColumns to remove automatic columns added to the control when the DataLink became active. The LayoutChanged method is called to refresh the control after updates to the Columns property.
|
||||
</p>
|
||||
<p>
|
||||
No actions are performed in the method when Value contains True.
|
||||
No actions are performed in the method when Value contains <b>True</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.LinkActive.Value">
|
||||
<short>True when the dataset is open.</short>
|
||||
<short><b>True</b> when the dataset is open.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCustomDBGrid.LayoutChanged">
|
||||
@ -5513,7 +5513,7 @@
|
||||
The value of the AutoAdvance property is set to aaRightDown, indicating the cell navigation is from left-to-right and then top-to-bottom in the grid control.
|
||||
</p>
|
||||
<p>
|
||||
Create sets the value in ScrollBars to ssBoth indicating that both horizontal and vertical scroll bars are needed, and sets AllowOutboundEvents to False to prevent forwarding of event notifications to the ancestor class.
|
||||
Create sets the value in ScrollBars to ssBoth indicating that both horizontal and vertical scroll bars are needed, and sets AllowOutboundEvents to <b>False</b> to prevent forwarding of event notifications to the ancestor class.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
@ -5602,7 +5602,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ResetColWidths</var> is a procedure used to restore column widths in the grid to their default values. ResetColWidths uses the value in DefaultColWidths to determine if default column widths are already in use. When DefaultColWidths contains True, no actions are performed in the method.
|
||||
<var>ResetColWidths</var> is a procedure used to restore column widths in the grid to their default values. ResetColWidths uses the value in DefaultColWidths to determine if default column widths are already in use. When DefaultColWidths contains <b>True</b>, no actions are performed in the method.
|
||||
</p>
|
||||
<p>
|
||||
ResetColWidths calls the RenewColWidths method to restore the column widths. The LayoutChanged method is called to refresh the grid control after the column layouts are altered.
|
||||
@ -5663,7 +5663,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.ExecuteAction.Result">
|
||||
<short>True DataLink is assigned, and the action was executed.</short>
|
||||
<short><b>True</b> DataLink is assigned, and the action was executed.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.ExecuteAction.AAction">
|
||||
<short>Action executed in the method.</short>
|
||||
@ -5677,7 +5677,7 @@
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.UpdateAction.Result">
|
||||
<short>True if DataLink is assigned, and the action was updated in the method.</short>
|
||||
<short><b>True</b> if DataLink is assigned, and the action was updated in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomDBGrid.UpdateAction.AAction">
|
||||
<short>Action updated in the method.</short>
|
||||
@ -5982,10 +5982,10 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is False in TDBGrid.
|
||||
ParentColor determines if the control should use the Color from the Parent control, when enabled. The default value for the property is <b>False</b> in TDBGrid.
|
||||
</p>
|
||||
<p>
|
||||
When this property is True, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to False.
|
||||
When this property is <b>True</b>, all changes to the Color of the parent will also be applied to the Color of the control, ensuring that they both contain same value. If the Color of the control is changed by the application, then ParentColor will be automatically set to <b>False</b>.
|
||||
</p>
|
||||
<p>
|
||||
Using ParentColor when the Color value is clDefault can cause problems in resolving the actual color value. To obtain the Color property of a control while taking into account clDefault and ParentColor, use the GetColorResolvingParent method. This method might return a non-RGB color, but will never return clDefault. To obtain a purely RGB result use the GetRGBColorResolvingParent method.
|
||||
@ -6049,7 +6049,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
The <var>Visible</var> property controls the ability to see a visual control. If Visible is True the control is shown otherwise it is hidden. Calling Show sets among other properties Visible to True. Setting Visible to <b>False</b> is equivalent to calling Hide method.
|
||||
The <var>Visible</var> property controls the ability to see a visual control. If Visible is <b>True</b> the control is shown otherwise it is hidden. Calling Show sets among other properties Visible to <b>True</b>. Setting Visible to <b>False</b> is equivalent to calling Hide method.
|
||||
</p>
|
||||
<remark>
|
||||
The Visible property does not depend on control's parent visibility. Use
|
||||
|
||||
Loading…
Reference in New Issue
Block a user