Class
SplashScreen

Definition

Namespace:Telerik.WinControls.UI.SplashScreen

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition

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()

Declaration

cs-api-definition

public SplashScreen()

Properties

Location

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

Declaration

cs-api-definition

public Point Location { get; set; }

Property Value

Point

StartPosition

Gets or sets the screen start position.

Declaration

cs-api-definition

public SplashStartPosition StartPosition { get; set; }

Property Value

SplashStartPosition

TopMost

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

Declaration

cs-api-definition

public virtual bool TopMost { get; set; }

Property Value

bool

Methods

AttachFormEvents(Form)

Attaches to the splash/overlay form events.

Declaration

cs-api-definition

protected virtual void AttachFormEvents(Form form)

Parameters

form

Form

The form

Close()

Closes the splash form.

Declaration

cs-api-definition

public virtual void Close()

CreateFrom()

Creates a splash form.

Declaration

cs-api-definition

public override RadSplashScreenForm CreateFrom()

Returns

RadSplashScreenForm

The created form.

Overrides BaseSplash<RadSplashScreenForm>.CreateFrom()

DetachFormEvents(Form)

Detaches from splash/overlay form events.

Declaration

cs-api-definition

protected virtual void DetachFormEvents(Form form)

Parameters

form

Form

The form

Dispose()

Declaration

cs-api-definition

public override void Dispose()

Overrides BaseSplash<RadSplashScreenForm>.Dispose()

SetContent(string)

Sets the main text if the displayed control is RadSplashScreenControl

Declaration

cs-api-definition

public virtual void SetContent(string text)

Parameters

text

string

The content text.

SetFooter(string)

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

Declaration

cs-api-definition

public virtual void SetFooter(string footerText)

Parameters

footerText

string

The footer text.

SetIcon(Image)

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

Declaration

cs-api-definition

public virtual void SetIcon(Image footerIcon)

Parameters

footerIcon

Image

The icon.

SetImage(Image)

Sets the main image if the displayed control is RadSplashScreenControl

Declaration

cs-api-definition

public virtual void SetImage(Image image)

Parameters

image

Image

The image.

SetProgress(int)

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

Declaration

cs-api-definition

public virtual void SetProgress(int progress)

Parameters

progress

int

The progress percentage.

SetSize(int, int)

Sets the size of the splash form.

Declaration

cs-api-definition

public virtual void SetSize(int width, int height)

Parameters

width

int

The height.

height

int

The width.

SetState(SplashScreenProgressIndicatorState)

Sets the progress indicator state if the displayed control is RadSplashScreenControl

Declaration

cs-api-definition

public virtual void SetState(SplashScreenProgressIndicatorState newState)

Parameters

newState

SplashScreenProgressIndicatorState

The new progress indicator state.

Show(RadSplashScreenSettings)

Shows a splash form with the default splash control.

Declaration

cs-api-definition

public virtual void Show(RadSplashScreenSettings settings)

Parameters

settings

RadSplashScreenSettings

The initial settings of the splash.

Show(Type)

Shows a splash form with given content type.

Declaration

cs-api-definition

public virtual void Show(Type contentType)

Parameters

contentType

Type

The type of the content.

ShowInternal(Type)

Declaration

cs-api-definition

protected virtual void ShowInternal(Type content)

Parameters

content

Type

ShowSplashForm(Form)

Declaration

cs-api-definition

protected virtual void ShowSplashForm(Form splashForm)

Parameters

splashForm

Form

ShowSplashScreen(Type)

Declaration

cs-api-definition

protected virtual void ShowSplashScreen(Type controlType)

Parameters

controlType

Type

ClassSplashScreen

Class
SplashScreen