TdxSplashFormBase Class

The base class for Splash and Wait Forms.

Declaration

TdxSplashFormBase = class(
    TObject
)

Remarks

Main API Members

The list below outlines key members of the TdxSplashFormBase class. You can use these members to hide/display a Splash Form and access/customize existing UI elements.

Size & Position

BoundsRect | SetBounds

Specify the form’s bounding rectangle.

Left | Top

Specify the form position (in relation to the target control/form).

Position

Allows you to switch between predefined and custom Splash Form positions.

Width | Height

Specify Splash Form dimensions.

Visibility Management

Hide

Hides the Splash Form if it is visible.

Visible

Indicates if the form is visible.

Terminal TdxSplashFormBase class descendants implement form type-specific visibility management methods:

TdxSplashForm.Preview | TdxWaitForm.Preview

Display a form in Preview mode. A user can click anywhere to close the displayed form.

TdxSplashForm.Show | TdxWaiForm.Show

Display a form. A user cannot close the displayed form. Call the Hide procedure to close the form.

UI Elements/Controls

All API members in this section allow you to access and modify existing UI elements/controls placed on the Splash Form. If the target predefined or custom UI element is not found, an exception occurs.

Tip

Use the Splash Form Designer dialog to add new or remove existing UI elements.

Animation

Provides access to an Animation/Activity Indicator element (TdxSplashFormBase.TAnimation) on the form.

GetItem

Provides access to any UI element/control on the form (by type and name).

Image

Provides access to an Image element (TdxSplashFormBase.TImage) on the form.

Progress

Provides access to a Progress Bar element (TdxSplashFormBase.TProgress) on the form.

Text

Provides access to a Text/Label element (TdxSplashFormBase.TText) on the form.

General-Purpose API Members

BeginUpdate | EndUpdate

Allow you to avoid excessive redraw operations during batch appearance setting changes.

Color

Specifies the form background color.

Default

Specifies if the Splash Form is used as default in the application.

Name

Specifies the Splash Form’s name (used in the Splash Form Manager and Project Settings).

Terminal TdxSplashFormBase Class Descendants

Do not use the TdxSplashFormBase class directly. Use the following descendants instead:

TdxSplashForm

A Splash Form designed to indicate application startup progress.

TdxWaitForm

A Wait Form you can display during time-consuming operations.

Inheritance

TObject

TdxSplashFormBase