Documentation

Class RadSplashScreenManager

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 or not there is a splash screen form opened.

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

SplashInstance

Gets or sets the splash screen instance.

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

ThemeName

Gets or sets the theme name of the splash form.

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

TopMost

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

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

Methods

Close()

Closes the splash form.

Declaration
public static void Close()

SetContent(String)

Sets the main text if the displayed control is RadSplashScreenControl

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

The content text.

SetFooter(String)

Sets the footer text if the displayed control is RadSplashScreenControl and the state is determinate.

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

The footer text.

SetIcon(Image)

Sets the footer icon if the displayed control is RadSplashScreenControl and the state is determinate.

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

The icon.

SetImage(Image)

Sets the main image if the displayed control is RadSplashScreenControl

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

The image.

SetProgress(Int32)

Sets the progress percentage if the displayed control is RadSplashScreenControl and the state is determinate.

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

The progress percentage.

SetSize(Int32, Int32)

Sets the size of the splash form.

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

The height.
System.Int32 height

The width.

SetState(SplashScreenProgressIndicatorState)

Sets the progress indicator state if the displayed control is RadSplashScreenControl

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

The new progress indicator state.

Show(Type)

Shows a splash form with given content type.

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

The type of the content.

Show(RadSplashScreenSettings)

Shows a splash form with the default splash control.

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

The initial settings of the splash.

Events

ContentCreated

Occurs when the content control has been created. Note that the control is created on a separate System.Threading.Thread and it is required to use BeginInvoke/Invoke when accessing it in order to prevent cross thread exceptions. Note that this is a static event and you need to explicitly unsubscribe from it in order to prevent memory leaks. Each object that is subscribed to this event cannot be garbage collected.

Declaration
public static event ContentCreatedEventHandler ContentCreated
Event Type
ContentCreatedEventHandler

Extension Methods