Table of Contents

Class SplashScreen

Namespace
PluginUI
Assembly
PluginUI.dll

Full-editor splash overlay (logo, title, subtitle) shown at startup; fades out after Duration or on click. Show it with ShowPopup(Popup).

public class SplashScreen : Popup
Inheritance
SplashScreen
Inherited Members

Constructors

SplashScreen(string?, string?)

Creates a splash screen.

public SplashScreen(string? title = null, string? subtitle = null)

Parameters

title string
subtitle string

Properties

Duration

Seconds before fading out (0 = stays until clicked).

public double Duration { get; set; }

Property Value

double

FadeDuration

Fade-out duration in seconds.

public double FadeDuration { get; set; }

Property Value

double

Fill

Background (null = theme background).

public Paint? Fill { get; set; }

Property Value

Paint

Image

Bitmap shown centered above the title (or as a background with ImageAsBackground).

public ImageSource? Image { get; set; }

Property Value

ImageSource

ImageAsBackground

Stretches Image over the whole editor.

public bool ImageAsBackground { get; set; }

Property Value

bool

Subtitle

Smaller text under the title (version, loading status...).

public string? Subtitle { get; set; }

Property Value

string

SVG logo shown centered above the title.

public SvgImage? SvgLogo { get; set; }

Property Value

SvgImage

Title

Big title.

public string? Title { get; set; }

Property Value

string

Methods

Dismiss()

Fades out and closes.

public void Dismiss()

MeasureOverride(Size)

Natural size of the content for the available size (margins excluded).

protected override Size MeasureOverride(Size available)

Parameters

available Size

Returns

Size

OnAttached()

Called when the element joins a host (subscribe to external events here).

protected override void OnAttached()

OnKeyDown(KeyEventArgs)

Keyboard routed to the popup when CapturesKeyboard is set; Escape closes by default.

protected override void OnKeyDown(KeyEventArgs e)

Parameters

e KeyEventArgs

OnMouseDown(MouseEventArgs)

Mouse button pressed over the element (or captured).

protected override void OnMouseDown(MouseEventArgs e)

Parameters

e MouseEventArgs

OnRender(DrawingContext)

Draws the element (below its children).

protected override void OnRender(DrawingContext dc)

Parameters

dc DrawingContext
Edit this page