Skip to main content
All docs
V26.1
  • TdxSplashFormBase.Progress(string) Method

    Provides access to a Progress Bar UI element on the form.

    Declaration

    function Progress(const AName: string = ''): TProgress;

    Parameters

    Name Type Description
    AName string

    Optional. Specifies the target Progress Bar UI element name.

    If you omit the AName parameter, the function returns the default/predefined Progress Bar UI element (if the form contains such a content item).

    Returns

    Type Description
    TdxSplashFormBase.TProgress

    Returns the Progress Bar UI element with the name passed as the AName parameter (or the default Progress Bar UI element if the optional parameter is omitted).

    If no UI element is found, an exception occurs.

    Remarks

    TdxSplashFormBase.TProgress is an animated progress bar you can place on a Splash or Wait form.

    Call the Progress function to access a Progress Bar UI element and modify its settings.

    Note

    The target UI element must be defined within the current form. Otherwise, a Progress function call raises an exception.

    Design Splash Forms & Manage UI Elements

    To add/remove individual UI elements to/from a Splash or Wait form, select the target form in the Project Settings dialog and click Customize… to display the Splash From Designer dialog.

    VCL Shared Libraries: The "Splash Form Designer" Dialog

    Other UI Element Access Methods

    Animation
    Provides access to an Animation/Activity Indicator UI element on the form.
    GetItem
    Provides access to any UI element on the form by type and name. Use the template parameter (T) to specify the target UI element type.
    Image
    Provides access to an Image UI element on the form.
    Text
    Provides access to a Text/Label UI element on the form.
    See Also