Documentation

Class SplashScreen

Inheritance
System.Object
BaseSplash<RadSplashScreenForm>
SplashScreen
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.SplashScreen
Assembly: Telerik.WinControls.UI.dll

Syntax

public class SplashScreen : BaseSplash<RadSplashScreenForm>, IDisposable

Constructors

SplashScreen()

Declaration
public SplashScreen()

Properties

Location

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

Declaration
public Point Location { get; set; }
Property Value
System.Drawing.Point

StartPosition

Gets or sets the screen start position.

Declaration
public SplashStartPosition StartPosition { get; set; }
Property Value
SplashStartPosition

TopMost

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

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

Methods

AttachFormEvents(Form)

Attaches to the splash/overlay form events.

Declaration
protected virtual void AttachFormEvents(Form form)
Parameters
System.Windows.Forms.Form form

The form

Close()

Closes the splash form.

Declaration
public virtual void Close()

CreateFrom()

Creates a splash form.

Declaration
public override RadSplashScreenForm CreateFrom()
Returns
RadSplashScreenForm

The created form.
Overrides
Telerik.WinControls.UI.SplashScreen.BaseSplash<Telerik.WinControls.UI.SplashScreen.RadSplashScreenForm>.CreateFrom()

DetachFormEvents(Form)

Detaches from splash/overlay form events.

Declaration
protected virtual void DetachFormEvents(Form form)
Parameters
System.Windows.Forms.Form form

The form

Dispose()

Declaration
public override void Dispose()
Overrides
Telerik.WinControls.UI.SplashScreen.BaseSplash<Telerik.WinControls.UI.SplashScreen.RadSplashScreenForm>.Dispose()

SetContent(String)

Sets the main text if the displayed control is RadSplashScreenControl

Declaration
public virtual 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 virtual 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 virtual 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 virtual 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 virtual void SetProgress(int progress)
Parameters
System.Int32 progress

The progress percentage.

SetSize(Int32, Int32)

Sets the size of the splash form.

Declaration
public virtual 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 virtual void SetState(SplashScreenProgressIndicatorState newState)
Parameters
SplashScreenProgressIndicatorState newState

The new progress indicator state.

Show(Type)

Shows a splash form with given content type.

Declaration
public virtual 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 virtual void Show(RadSplashScreenSettings settings)
Parameters
RadSplashScreenSettings settings

The initial settings of the splash.

ShowInternal(Type)

Declaration
protected virtual void ShowInternal(Type content)
Parameters
System.Type content

ShowSplashForm(Form)

Declaration
protected virtual void ShowSplashForm(Form splashForm)
Parameters
System.Windows.Forms.Form splashForm

ShowSplashScreen(Type)

Declaration
protected virtual void ShowSplashScreen(Type controlType)
Parameters
System.Type controlType

Extension Methods