Skip to main content
All docs
V26.1
  • TdxSplashFormBase.EndUpdate(Boolean,Cardinal) Method

    Applies all pending changes and redraws the Splash Form after a BeginUpdate procedure call.

    Declaration

    procedure EndUpdate(AWaitForCompletion: Boolean = False; ATimeout: Cardinal = INFINITE);

    Parameters

    Name Type Description
    AWaitForCompletion Boolean

    Optional. Specifies if the EndUpdate procedure call unlocks Splash Form updates immediately:

    False
    Default. Form redraw/update operations are resumed immediately after the current EndUpdate call.
    True
    The EndUpdate procedure call resumes form redraw/update operations once all pending change calls are executed. The optional ATimeout parameter allows you to define a timeout interval for pending call execution.
    ATimeout Cardinal

    Optional. Specifies a timeout interval (in milliseconds) for pending call execution after an EndUpdate call if AWaitForCompletion is True.

    If the ATimeout parameter is omitted, no timeout interval (INFINITE) is defined for pending call execution.

    Remarks

    Every time a form or visual element setting is changed, the Splash Form is redrawn to reflect the change. Enclose multiple form/visual element setting changes between BeginUpdate and EndUpdate procedure calls to avoid excessive redraw operations.

    BeginUpdate/EndUpdate and Batch Changes

    A BeginUpdate procedure call disables notifications and postpones all changes until an EndUpdate call. A subsequent EndUpdate call does the following:

    • Re-enables change notifications and corresponding redraw operations
    • Applies all changes made after a BeginUpdate call
    • Sends corresponding notifications in a batch
    • Redraws the visible Splash Form

    Note

    Ensure that every BeginUpdate procedure call is followed by an EndUpdate call, even if an exception occurs. Otherwise, the form remains frozen and unresponsive.

    See Also