New to Telerik UI for WinForms? Start a free 30-day trial

Creates and manages a splash form on a background STA thread, using the default splash control or custom form/control content.

Definition

Constructors

Creates a splash screen configured to be topmost and centered on the current screen.

C#
public SplashScreen()

Properties

Gets or sets the desktop location when the StartPosition is Manual.

C#
public Point Location { get; set; }

Gets or sets the screen start position.

C#
public SplashStartPosition StartPosition { get; set; }

Gets or sets a value indicating whether the splash form will be top most.

C#
public virtual bool TopMost { get; set; }

Methods

Attaches to the splash/overlay form events.

C#
protected virtual void AttachFormEvents(Form form)
Parameters:formForm

The form

Closes the splash form.

C#
public virtual void Close()

Creates a splash form.

C#
public override RadSplashScreenForm CreateFrom()
Returns:

RadSplashScreenForm

The created form.

Overrides: BaseSplash<RadSplashScreenForm>.CreateFrom()

Detaches from splash/overlay form events.

C#
protected virtual void DetachFormEvents(Form form)
Parameters:formForm

The form

Disposes the base splash state and clears the pending default settings.

C#
public override void Dispose()

Overrides: BaseSplash<RadSplashScreenForm>.Dispose()

Sets the main text if the displayed control is RadSplashScreenControl

C#
public virtual void SetContent(string text)
Parameters:textstring

The content text.

Sets the footer text if the displayed control is RadSplashScreenControl.

C#
public virtual void SetFooter(string footerText)
Parameters:footerTextstring

The footer text.

Sets the footer icon if the displayed control is RadSplashScreenControl.

C#
public virtual void SetIcon(Image footerIcon)
Parameters:footerIconImage

The icon.

Sets the main image if the displayed control is RadSplashScreenControl

C#
public virtual void SetImage(Image image)
Parameters:imageImage

The image.

Sets the progress value when the displayed control is RadSplashScreenControl. The value is shown when the progress indicator is in the determinate state.

C#
public virtual void SetProgress(int progress)
Parameters:progressint

The progress percentage.

Sets the size of the splash form and, when using the default splash control, resizes its content to fit.

C#
public virtual void SetSize(int width, int height)
Parameters:widthint

The width of the splash form.

heightint

The height of the splash form.

Sets the progress indicator state if the displayed control is RadSplashScreenControl

C#
public virtual void SetState(SplashScreenProgressIndicatorState newState)
Parameters:newStateSplashScreenProgressIndicatorState

The new progress indicator state.

Shows a splash form with the default splash control.

C#
public virtual void Show(RadSplashScreenSettings settings)
Parameters:settingsRadSplashScreenSettings

The initial settings of the splash.

Shows a splash form with given content type.

C#
public virtual void Show(Type contentType)
Parameters:contentTypeType

The type of the content.

Starts the splash on a background thread, or throws if another splash is already active.

C#
protected virtual void ShowInternal(Type content)
Parameters:contentType

The type of the form or control to display.

Exceptions: InvalidOperationException

A splash screen is already active.

Attaches splash lifecycle handlers and starts a message loop for the form on the splash thread.

C#
protected virtual void ShowSplashForm(Form splashForm)
Parameters:splashFormForm

The form to show.

Creates the requested content and displays it as a form or within the splash form. The default control receives the pending RadSplashScreenSettings when settings were supplied.

C#
protected virtual void ShowSplashScreen(Type controlType)
Parameters:controlTypeType

A type that creates a Form or Control to display.

Exceptions: ArgumentException

The created instance is neither a form nor a control.