.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
The page you are viewing does not exist in the .NET Standard 2.0+ platform documentation. This link will take you to the parent topic of the current section.
.NET Core 3.0+

DXSplashScreen Members

Uses the WinForms Splash Screen Manager and enables a Splash Screen, a Wait Form, a Splash Image, and an Overlay Form in XAF Win applications.

Constructors

Name Description
DXSplashScreen() Initializes a new DXSplashScreen class instance that shows the default splash form.
DXSplashScreen(SvgImage) Initializes a new DXSplashScreen class instance that shows a Splash Image.
DXSplashScreen(SvgImage, Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified Splash Image, Wait Form, and Overlay Form.
DXSplashScreen(Image) Initializes a new DXSplashScreen class instance that shows the specified a Splash Image.
DXSplashScreen(Image, Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified a Splash Image, a Wait Form, and an Overlay Form.
DXSplashScreen(String) For internal use.
DXSplashScreen(Type) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen.
DXSplashScreen(Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen and an Overlay Form.
DXSplashScreen(Type, SvgImage, Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen, a Splash Image, a Wait Form, and an Overlay Form.
DXSplashScreen(Type, Image, Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen, a Splash Image, a Wait Form, and an Overlay Form.
DXSplashScreen(Type, Type) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen and Wait Form.
DXSplashScreen(Type, Type, DefaultOverlayFormOptions) Initializes a new DXSplashScreen class instance that shows the specified Splash Screen, Wait Form, and Overlay Form.

Fields

Name Description
DefaultSplashScreenType static For internal use.
DefaultUpdateDelay static Defines how often a splash form retrieves and displays status messages. Only Splash Screens and Wait Forms can show status messages.

Properties

Name Description
CanShowOverlayForm Indicates if the current DXSplashScreen instance can show an Overlay Form.
IsStarted Checks if either of the following splash forms is currently shown: a Splash Screen or a Wait Form.
OverlayFormOptions Gets Overlay Form options.
SplashFormType Gets a Splash Screen form type.
SplashImage Gets a raster image to be shown as a Splash Image.
SplashSvgImage Gets an SVG image to be shown as a Splash Image.
UpdateDelay Defines how often a splash form retrieves and displays status messages. Only Splash Screens and Wait Forms can show status messages.
WaitFormType Returns a Wait Form type.

Methods

Name Description
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetType() Gets the Type of the current instance. Inherited from Object.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
SetDisplayText(String) Updates a Splash Screen‘s or Wait Form‘s description text.
Start() Shows a Splash Screen or Splash Image.
Start(SplashType) Shows a specified splash forms: a Splash Screen, a Wait Form or a Splash Image.
StartOverlayForm(Control) Shows an Overlay Form over a specified control.
Stop() Closes a Splash Screen or Splash Image.
Stop(SplashType) Closes a specified splash form: a Splash Screen, a Wait Form or a Splash Image.
StopOverlayForm(IOverlaySplashScreenHandle) Stops and closes a specific Overlay Form.
ToString() Returns a string that represents the current object. Inherited from Object.
UpdateSplash(String, String, Object[]) Specifies a description text, caption, and additional parameters for splash forms. Applies to the following splash forms: a Splash Screen or a Wait Form.

Events

Name Description
Showing Is raised before a splash form is shown.
See Also