Docs: LCL/comctrls. Adds TCustomTabControl.ActivateFirstControlOnPage topic for changes in e5a63799. Issue #40775.

* Updates TCustomTabControl.Change.
This commit is contained in:
dsiders 2024-02-24 18:46:16 +00:00
parent f697aec2d2
commit 75eb44e0c4

View File

@ -4194,6 +4194,70 @@ Ordinal position for the page object removed from the page list.
</short>
</element>
<element name="TCustomTabControl.ActivateFirstControlOnPage">
<short>
Updates the ActiveControl on the parent form when the specified page becomes
active.
</short>
<descr>
<p>
<var>ActivateFirstControlOnPage</var> is a method used to ensure that the
active control on a form is properly updated when the page on the tab control
is changed. It prevents the tabbed control from stealing focus if there is an
enabled child control on the page specified in <var>APage</var>. It sets the
ActiveControl property on the parent form to the first child control in APage
(when available).
</p>
<p>
No actions are performed in the method if any of the following conditions are
detected:
</p>
<ul>
<li>
The parent form for the tab control has not been assigned.
</li>
<li>
APage has not been assigned.
</li>
<li>
APage is not visible.
</li>
<li>
APage is not enabled.
</li>
<li>
APage does not have any child controls.
</li>
</ul>
<p>
ActivateFirstControlOnPage is called from the Change method, and when a new
value is assigned to the TabIndex property. It occurs after the current Page on
the tab control has been made visible and given focus. It occurs before the
OnChange event handler is signalled.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TCustomTabControl.ActivePage"/>
<link id="TCustomTabControl.ActivePageComponent"/>
<link id="TCustomTabControl.Change"/>
<link id="TCustomTabControl.CanChange"/>
<link id="TCustomTabControl.OnChanging"/>
<link id="TCustomTabControl.OnChange"/>
<link id="TCustomTabControl.TabIndex"/>
<link id="#lcl.forms.GetParentForm">GetParentForm</link>
<link id="#lcl.forms.TCustomForm.ActiveControl">TCustomForm.ActiveControl</link>
<link id="#lcl.controls.TWinControl.FindNextControl">TWinControl.FindNextControl</link>
</seealso>
</element>
<element name="TCustomTabControl.ActivateFirstControlOnPage.APage">
<short>
Tab page with child controls examined in the method.
</short>
</element>
<element name="TCustomTabControl.CanChange">
<short>
Signals the OnChanging event handler prior to updates to PageIndex.