Back to Devexpress

SplashScreenManager Members

windowsforms-devexpress-dot-xtrasplashscreen-dot-splashscreenmanager-dot-underscore-members.md

latest46.6 KB
Original Source

SplashScreenManager Members

Allows you to create and show splash screens and wait forms.

Constructors

NameDescription
SplashScreenManager()Initializes a new instance of the SplashScreenManager class with default settings.
SplashScreenManager(Type, SplashFormProperties)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(Type, SplashFormStartPosition, Point, SplashFormProperties, ParentFormState)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Type, SplashFormStartPosition, Point, SplashFormProperties)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point, Boolean)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point, Int32)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Form, Type, Boolean, Boolean, Boolean)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(Form, Type, Boolean, Boolean, Int32)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(Form, Type, Boolean, Boolean)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, ParentType, Boolean)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, ParentType)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentType, Boolean)Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentType)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, Type, Boolean)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, Type)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, Type, Boolean)Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(UserControl, Type, Boolean, Boolean, Type)Initializes a new instance of the SplashScreenManager class with the specified settings.

Properties

NameDescription
ActivateParentOnSplashFormClosing staticGets or sets whether a splash form’s parent is activated on closing the splash form.
ActivateParentOnWaitFormClosing staticGets or sets whether a WaitForm‘s parent is activated on closing the WaitForm.
ActiveSplashFormTypeInfoGets or sets the type of the splash form to be displayed by the SplashScreenManager.
ApartmentState staticGets or sets the apartment state of the splash screen’s thread.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ClosingDelayGets or sets the delay, in milliseconds, before the splash form is closed.
ContainerGets the IContainer that contains the Component. Inherited from Component.
Default staticReturns the default SplashScreenManager that allows you to interact with the currently displayed splash forms.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FormInPendingState staticGets whether a splash form has been created, but not yet displayed. The splash form will be displayed a short time (pending time) after it has been created, provided that it is not closed during this time.
IsSplashFormVisibleGets whether a SplashScreen or WaitForm is being currently displayed.
PaletteName staticGets or sets the name of the palette used to colorize vector images.
PropertiesContains properties controlling a form’s appearance.
SiteGets or sets the ISite of the Component. Inherited from Component.
SkinName staticThis member supports the internal infrastructure, and is not intended to be used directly from your code.
SplashFormLocationGets or sets the screen coordinates at which a splash form (SplashScreen or WaitForm) will be displayed.
SplashFormStartPositionGets or sets the arrangement of a splash form (SplashScreen or WaitForm).

Methods

NameDescription
CanStartSplashScreenManagerUIThread() static
CloseForm() staticCloses the wait form or splash screen. Throws an exception if no splash form is opened.
CloseForm(Boolean, Boolean) staticCloses the wait form or splash screen.
CloseForm(Boolean, Int32, Form, Boolean, Boolean) staticCloses the wait form or splash screen. For internal use.
CloseForm(Boolean, Int32, Form, Boolean) staticCloses the wait form or splash screen after a delay.
CloseForm(Boolean, Int32, Form) staticCloses the wait form or splash screen after a delay. Allows you to select the form that should be subsequently activated, and suppress the exception raised if no splash form is opened.
CloseForm(Boolean) staticCloses the displayed wait form or splash screen. Allows you to suppress the exception raised if no splash form is opened.
CloseOverlayForm(IOverlaySplashScreenHandle) staticCloses the Overlay Form with the specified handle.
CloseWaitForm()Closes the WaitForm that was displayed using the SplashScreenManager.ShowWaitForm method.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
HideImage() staticHides the splash image that has been displayed via the SplashScreenManager.ShowImage method.
HideImage(Int32, Form) staticCloses the currently displayed splash image after a specific delay and allows you to specify a form that should be subsequently selected.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Invalidate()Forces the splash form to be redisplayed.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RegisterUserSkin(SkinBlobXmlCreator) staticRegisters a custom skin to be applied to a splash form.
RegisterUserSkins(Assembly) staticRegisters custom skins from the specified assembly to be applied to a splash form.
SendCommand(Enum, Object)Sends a command to the currently active splash form.
SetWaitFormCaption(String)Sets the active WaitForm‘s caption to the specified value.
SetWaitFormDescription(String)Sets the active WaitForm‘s description to the specified value.
ShowFluentSplashScreen(FluentSplashScreenOptions, EventHandler<FluentSplashScreenCustomDrawEventArgs>, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) staticDisplays a Windows 10-inspired splash screen (features an Acrylic material effect - a partially transparent texture).
ShowFluentSplashScreen(String, String, String, String, Int32, Color, FluentLoadingIndicatorType, ImageOptions, EventHandler<FluentSplashScreenCustomDrawEventArgs>, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) staticDisplays a Windows 10-inspired splash screen (features an Acrylic material effect - a partially transparent texture).
ShowForm(Type, Boolean, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Type) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, SplashFormStartPosition) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean, ParentFormState, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type. For internal use.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean, ParentFormState) staticCreates and displays a splash form (wait form or splash screen) of the specified type. For internal use.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type. For internal use.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean, Int32) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type, Boolean, Boolean) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(Form, Type) staticCreates and displays a splash form (wait form or splash screen) of the specified type.
ShowForm(UserControl, Type, Boolean, Boolean, ParentFormState) staticCreates and displays a wait form of the specified type.
ShowForm(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) staticCreates and displays a wait form of the specified type.
ShowForm(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point) staticCreates and displays a wait form of the specified type.
ShowForm(UserControl, Type, Boolean, Boolean, SplashFormStartPosition) staticCreates and displays a wait form of the specified type.
ShowForm(UserControl, Type, Boolean, Boolean) staticCreates and displays a wait form of the specified type.
ShowImage(SvgImage, Boolean, Boolean, ICustomImagePainter) staticDisplays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter, Int32) staticCreates a splash form with a vector image inside and displays this form after the specified delay. Allows you to draw custom graphics over the splash image, manually arrange it, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter) staticDisplays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, manually arrange it, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Boolean, Boolean, SplashFormStartPosition, Point) staticDisplays a splash form that contains a vector image. Allows you to manually arrange this splash form.
ShowImage(SvgImage, Boolean, Boolean) staticDisplays a vector image as a splash form with optional fade-in and fade-out effects.
ShowImage(SvgImage, Boolean) staticDisplays a vector image with an optional fade in effect.
ShowImage(SvgImage, Size, Boolean, Boolean, ICustomImagePainter) staticDisplays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, resize the image, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Size, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter, Int32) staticCreates a splash form with a vector image inside and displays this form after the specified delay. Allows you to draw custom graphics over the splash image, resize and manually arrange it, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Size, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter) staticDisplays a splash form that contains a vector image. Allows you to draw custom graphics over the splash image, resize and manually arrange it, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Size, Boolean, Boolean, SplashFormStartPosition, Point) staticDisplays a splash form that contains a vector image. Allows you to manually arrange this splash form, resize the image, and enable fade-in and fade-out effects.
ShowImage(SvgImage, Size, Boolean, Boolean) staticDisplays a vector image as a splash form, centering the image against your application’s main form. Allows you to disable fade-in and fade-out effects for the image.
ShowImage(SvgImage, Size, Boolean) staticResizes an image and shows it as a splash form with an optional fade-in effect.
ShowImage(SvgImage, Size) staticResizes the target vector image and shows it as a splash form.
ShowImage(SvgImage) staticDisplays a vector image as a splash form, centering the image against your application’s main form.
ShowImage(Image, Boolean, Boolean, ICustomImagePainter) static

Displays an image as a splash form, centering the image against your application’s main form. Allows you to disable fade-in and fade-out effects for the image and draw custom graphics over the splash image.

| | ShowImage(Image, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter, Int32, Boolean) static | This method supports the internal infrastructure, and is not intended to be used directly from your code. | | ShowImage(Image, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter, Int32) static | Creates a splash form containing the specified image and displays it after a delay. Allows you to manually position the splash form, disable fade-in and fade-out effects for the image and draw custom graphics over the splash image. | | ShowImage(Image, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter) static | Displays an image as a splash form, allowing you to manually position it against your application’s main form. Allows you to disable fade-in and fade-out effects for the image and draw custom graphics over the splash image. | | ShowImage(Image, Boolean, Boolean, SplashFormStartPosition, Point) static | Displays an image as a splash form, allowing you to manually position it. Allows you to disable fade-in and fade-out effects for the image. | | ShowImage(Image, Boolean, Boolean) static | Displays an image as a splash form, centering the image against your application’s main form. Allows you to disable fade-in and fade-out effects for the image. | | ShowImage(Image, Boolean) static | Displays an image as a splash form, centering the image against your application’s main form. | | ShowImage(Image) static | Displays an image as a splash form, centering the image against your application’s main form. | | ShowOverlayForm(Control, OverlayWindowOptions) static | Shows an Overlay Form with the specified options over the specified control. | | ShowOverlayForm(Control, Nullable<Boolean>, Nullable<Boolean>, Nullable<Color>, Nullable<Color>, Nullable<Int32>, Image, IOverlayWindowPainter, String, Nullable<ImageRotationParams>, Nullable<Int32>, Nullable<Size>, Nullable<WaitAnimationType>, Nullable<LineAnimationParams>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>) static | | | ShowOverlayForm(Control) static | Shows an Overlay Form with the default options over the specified control. | | ShowSkinSplashScreen(SvgImage, Nullable<Size>, String, String, String, String, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) static | Displays a skin-aware splash screen with the specified SVG logo image. The current skin determines the background and font settings splash screen elements. | | ShowSkinSplashScreen(Image, String, String, String, String, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) static | Displays a skin-aware splash screen with the specified raster logo image. The current skin determines the background and font settings of the splash screen’s elements. | | ShowSkinSplashScreen(String, String, String, String, Form, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) static | Displays a skin-aware splash screen. The current skin determines the background and font settings of the splash screen’s elements. | | ShowWaitForm() | Creates and displays a WaitForm, whose type is specified by the SplashScreenManager.ActiveSplashFormTypeInfo property. | | ToString() | Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. | | WaitForSplashFormClose() | Blocks the current thread until the active splash form is closed. |

Events

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

SplashScreenManager Class

DevExpress.XtraSplashScreen Namespace