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

SplashScreen

Class

Definition

Namespace:Telerik.WinControls.UI.SplashScreen

Assembly:Telerik.WinControls.UI.dll

Syntax:

public class SplashScreen : BaseSplash<RadSplashScreenForm>, IDisposable

Inheritance: objectBaseSplash<RadSplashScreenForm>SplashScreen

Implements: IDisposable

Inherited Members BaseSplash<RadSplashScreenForm>.CreateAndStartBackgroundThreadWithAction(ThreadStart)BaseSplash<RadSplashScreenForm>.ExecuteAction(Action)BaseSplash<RadSplashScreenForm>.FormBaseSplash<RadSplashScreenForm>.AnimationManagerBaseSplash<RadSplashScreenForm>.IsActiveBaseSplash<RadSplashScreenForm>.ThemeNameBaseSplash<RadSplashScreenForm>.Thread...

Constructors

SplashScreen()

public SplashScreen()

Properties

Location

Point

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

public Point Location { get; set; }

StartPosition

SplashStartPosition

Gets or sets the screen start position.

public SplashStartPosition StartPosition { get; set; }

TopMost

bool

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

public virtual bool TopMost { get; set; }

Methods

AttachFormEvents(Form)

Attaches to the splash/overlay form events.

protected virtual void AttachFormEvents(Form form)

Parameters:formForm

The form

Close()

Closes the splash form.

public virtual void Close()

CreateFrom()

Creates a splash form.

public override RadSplashScreenForm CreateFrom()

Returns:

RadSplashScreenForm

The created form.

Overrides: BaseSplash<RadSplashScreenForm>.CreateFrom()

DetachFormEvents(Form)

Detaches from splash/overlay form events.

protected virtual void DetachFormEvents(Form form)

Parameters:formForm

The form

Dispose()

public override void Dispose()

Overrides: BaseSplash<RadSplashScreenForm>.Dispose()

SetContent(string)

Sets the main text if the displayed control is RadSplashScreenControl

public virtual void SetContent(string text)

Parameters:textstring

The content text.

SetFooter(string)

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

public virtual void SetFooter(string footerText)

Parameters:footerTextstring

The footer text.

SetIcon(Image)

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

public virtual void SetIcon(Image footerIcon)

Parameters:footerIconImage

The icon.

SetImage(Image)

Sets the main image if the displayed control is RadSplashScreenControl

public virtual void SetImage(Image image)

Parameters:imageImage

The image.

SetProgress(int)

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

public virtual void SetProgress(int progress)

Parameters:progressint

The progress percentage.

SetSize(int, int)

Sets the size of the splash form.

public virtual void SetSize(int width, int height)

Parameters:widthint

The height.

heightint

The width.

SetState(SplashScreenProgressIndicatorState)

Sets the progress indicator state if the displayed control is RadSplashScreenControl

public virtual void SetState(SplashScreenProgressIndicatorState newState)

Parameters:newStateSplashScreenProgressIndicatorState

The new progress indicator state.

Show(RadSplashScreenSettings)

Shows a splash form with the default splash control.

public virtual void Show(RadSplashScreenSettings settings)

Parameters:settingsRadSplashScreenSettings

The initial settings of the splash.

Show(Type)

Shows a splash form with given content type.

public virtual void Show(Type contentType)

Parameters:contentTypeType

The type of the content.

ShowInternal(Type)

protected virtual void ShowInternal(Type content)

Parameters:contentType

ShowSplashForm(Form)

protected virtual void ShowSplashForm(Form splashForm)

Parameters:splashFormForm

ShowSplashScreen(Type)

protected virtual void ShowSplashScreen(Type controlType)

Parameters:controlTypeType