Class RadSplashScreenManager

Provides static methods and properties for managing splash screens that display application loading, progress, or startup information. A splash screen is typically shown during application initialization to provide visual feedback to users while the application loads.

Inheritance
System.Object
BaseSplashManager
RadSplashScreenManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadSplashScreenManager : BaseSplashManager

Constructors

RadSplashScreenManager()

Declaration
public RadSplashScreenManager()

Properties

IsActive

Gets a value indicating whether a splash screen form is currently active and displayed.

Declaration
public static bool IsActive { get; }
Property Value
System.Boolean

true if a splash screen is currently open; otherwise, false.

SplashInstance

Gets or sets the current splash screen instance used for displaying splash content. If no instance exists, a new SplashScreen will be created automatically.

Declaration
public static SplashScreen SplashInstance { get; set; }
Property Value
SplashScreen

The current SplashScreen instance.

ThemeName

Gets or sets the theme name applied to the splash screen form and its controls. This allows the splash screen to match the application's visual theme.

Declaration
public static string ThemeName { get; set; }
Property Value
System.String

The name of the theme to apply to the splash screen.

TopMost

Gets or sets a value indicating whether the splash screen form will be displayed as the topmost window above all other windows. When set to true, the splash screen will appear on top of all other applications.

Declaration
public static bool TopMost { get; set; }
Property Value
System.Boolean

true if the splash form should be topmost; otherwise, false.

Methods

Close()

Closes the currently active splash screen form and removes it from view. If no splash screen is currently displayed, this method has no effect.

Declaration
public static void Close()

SetContent(String)

Sets the main text content displayed in the splash screen when using RadSplashScreenControl. This method only affects splash screens that contain a RadSplashScreenControl.

Declaration
public static void SetContent(string text)
Parameters
System.String text

The text content to display in the splash screen.

SetFooter(String)

Sets the footer text displayed at the bottom of the splash screen when using RadSplashScreenControl. This method only affects splash screens that contain a RadSplashScreenControl.

Declaration
public static void SetFooter(string footerText)
Parameters
System.String footerText

The text to display in the footer area of the splash screen.

SetIcon(Image)

Sets the footer icon displayed in the splash screen when using RadSplashScreenControl. This method only affects splash screens that contain a RadSplashScreenControl.

Declaration
public static void SetIcon(Image footerIcon)
Parameters
System.Drawing.Image footerIcon

The icon image to display in the footer area of the splash screen.

SetImage(Image)

Sets the main image displayed in the splash screen when using RadSplashScreenControl. This method only affects splash screens that contain a RadSplashScreenControl.

Declaration
public static void SetImage(Image image)
Parameters
System.Drawing.Image image

The image to display as the main visual element of the splash screen.

SetProgress(Int32)

Sets the progress percentage value when using RadSplashScreenControl with determinate progress state. This method only affects splash screens that contain a RadSplashScreenControl with determinate progress.

Declaration
public static void SetProgress(int progress)
Parameters
System.Int32 progress

The progress percentage value, typically between 0 and 100.

SetSize(Int32, Int32)

Sets the dimensions of the splash screen form to the specified width and height. This method allows dynamic resizing of the splash screen during runtime.

Declaration
public static void SetSize(int width, int height)
Parameters
System.Int32 width

The desired width of the splash form in pixels.
System.Int32 height

The desired height of the splash form in pixels.

SetState(SplashScreenProgressIndicatorState)

Sets the progress indicator state when using RadSplashScreenControl, controlling whether progress is shown as determinate, indeterminate, or hidden. This method only affects splash screens that contain a RadSplashScreenControl.

Declaration
public static void SetState(SplashScreenProgressIndicatorState newState)
Parameters
SplashScreenProgressIndicatorState newState

The new progress indicator state determining how progress is visualized.

Show(Type)

Displays a splash screen form with custom content created from the specified type. The content type must inherit from Control or Form to be displayed properly.

Declaration
public static void Show(Type contentType)
Parameters
System.Type contentType

The type of control or form to create and display as the splash screen content.

Show(RadSplashScreenSettings)

Displays a splash screen form using the default RadSplashScreenControl with the specified initial settings. This method provides a quick way to show a splash screen with predefined configuration.

Declaration
public static void Show(RadSplashScreenSettings settings)
Parameters
RadSplashScreenSettings settings

The initial configuration settings for the splash screen including size, position, and appearance options.

Events

ContentCreated

Occurs when the splash screen content control has been created and initialized, but before it is displayed. This event allows customization of the content before it becomes visible to the user. Note that the control is created on a separate thread and it is required to use BeginInvoke/Invoke when accessing it to prevent cross-thread exceptions. Note that this is a static event and you need to explicitly unsubscribe from it to prevent memory leaks. Each object subscribed to this event cannot be garbage collected.

Declaration
public static event ContentCreatedEventHandler ContentCreated
Event Type
ContentCreatedEventHandler

Extension Methods