A newer version of this page is available. Switch to the current version.

SplashScreenManager Members

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

Constructors

Name Description
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) Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Type, SplashFormStartPosition, Point, SplashFormProperties, ParentFormState) Initializes a new instance of the SplashScreenManager class with specific settings.
SplashScreenManager(Form, Type, Boolean, Boolean) Initializes a new instance of the SplashScreenManager class with the specified settings.
SplashScreenManager(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point) 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, 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(UserControl, Type, Boolean, Boolean, ParentType) 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, SplashFormStartPosition, Point, 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, Type) 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, 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.

Properties

Name Description
ActivateParentOnSplashFormClosing static Gets or sets whether a splash form's parent is activated on closing the splash form.
ActivateParentOnWaitFormClosing static Gets or sets whether a WaitForm's parent is activated on closing the WaitForm.
ActiveSplashFormTypeInfo Gets or sets the type of the splash form to be displayed by the SplashScreenManager.
ApartmentState static Gets or sets the apartment state of the splash screen's thread.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
ClosingDelay Gets or sets the delay, in milliseconds, before the splash form is closed.
Container Gets the IContainer that contains the Component. Inherited from Component.
Default static Returns the default SplashScreenManager that allows you to interact with the currently displayed splash forms.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FormInPendingState static Gets 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.
IsSplashFormVisible Gets whether a SplashScreen or WaitForm is being currently displayed.
PaletteName static Gets or sets the name of the palette used to colorize vector images.
Properties Contains properties controlling a form's appearance.
Site Gets or sets the ISite of the Component. Inherited from Component.
SkinName static This member supports the internal infrastructure, and is not intended to be used directly from your code.
SplashFormLocation Gets or sets the screen coordinates at which a splash form (SplashScreen or WaitForm) will be displayed.
SplashFormStartPosition Gets or sets the arrangement of a splash form (SplashScreen or WaitForm).

Methods

Name Description
CloseDefaultSplashScreen() static Closes the currently displayed SplashScreen or WaitForm. The method throws an exception if no splash form is currently open.
CloseDefaultWaitForm() static Closes the currently displayed SplashScreen or WaitForm. The method throws an exception if no splash form is currently open.
CloseForm() static Closes the currently displayed SplashScreen or WaitForm, that has been displayed using the SplashScreenManager.ShowForm method. The method throws an exception if no splash form is currently open.
CloseForm(Boolean) static Closes the currently displayed SplashScreen or WaitForm, that has been displayed using the SplashScreenManager.ShowForm method. The method's parameter allows you to suppress an exception that is raised when no splash form is currently opened.
CloseForm(Boolean, Boolean) static Closes the currently displayed SplashScreen or WaitForm, and blocks the current thread until the splash form has actually been closed. The method's parameter allows you to suppress an exception that is raised when no splash form is currently opened.
CloseForm(Boolean, Int32, Form) static Closes the currently displayed SplashScreen or WaitForm after a specified delay. Allows you to select a form that should be subsequently activated, and suppress an exception that is raised when no splash form is currently opened.
CloseForm(Boolean, Int32, Form, Boolean) static Closes the currently displayed SplashScreen or WaitForm after a specified delay, and blocks the current thread until the splash form has actually been closed. Allows you to select a form that should be subsequently activated, and suppress an exception that is raised when no splash form is currently opened.
CloseForm(Boolean, Int32, Form, Boolean, Boolean) static Closes the currently displayed SplashScreen or WaitForm. This member supports the internal infrastructure, and is not intended to be used directly from your code.
CloseOverlayForm(IOverlaySplashScreenHandle) static Closes 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) 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.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns 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() static Hides the splash image that has been displayed via the SplashScreenManager.ShowImage method.
HideImage(Int32, Form) static Closes 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() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RegisterUserSkin(SkinBlobXmlCreator) static Registers a custom skin to be applied to a splash form.
RegisterUserSkins(Assembly) static Registers 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.
SetDefaultProgressSplashScreenValue(Boolean, Int32) static Set the value of the progress bar in the predefined SplashScreen descendant.
SetDefaultSplashScreenStatus(Boolean, String) static Sets the caption of the progress bar in the predefined SplashScreen descendant.
SetWaitFormCaption(String) Sets the active WaitForm's caption to the specified value.
SetWaitFormDescription(String) Sets the active WaitForm's description to the specified value.
ShowDefaultProgressSplashScreen(String) static Creates and displays the predefined SplashScreen descendant.
ShowDefaultSplashScreen(String, String) static Creates and displays the predefined SplashScreen descendant.
ShowDefaultSplashScreen(Form, Boolean, Boolean, String, String) static Creates and displays the predefined SplashScreen descendant.
ShowDefaultWaitForm(String, String) static Creates and displays the predefined WaitForm descendant, centering it against your application's main form.
ShowDefaultWaitForm(Form, Boolean, Boolean, Boolean, Int32, String, String) static Creates and displays the predefined WaitForm descendant, centering it against another form.
ShowDefaultWaitForm(Form, Boolean, Boolean, String, String) static Creates and displays the predefined WaitForm descendant, centering it against another form.
ShowForm(Type) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against your application's main form.
ShowForm(Type, Boolean, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant, centering against your application's main form.
ShowForm(Form, Type) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form.
ShowForm(Form, Type, Boolean, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form.
ShowForm(Form, Type, Boolean, Boolean, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowForm(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it.
ShowForm(Form, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowForm(Form, Type, Boolean, Boolean, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form. The method's parameter allows you to suppress an exception that is thrown if another splash form has already been opened.
ShowForm(Form, Type, Boolean, Boolean, Boolean, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it. The method's parameter allows you to suppress an exception that is thrown if another splash form has already been opened.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it. The method's parameter allows you to specify whether the splash form is displayed using the glow effect.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32) static Creates the specified SplashScreen or WaitForm descendant and displays it after a delay. Allows you to manually position the splash form, and suppress an exception that is thrown if another splash form has already been opened.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant, allowing you to manually position it. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean, ParentFormState) static Creates and displays the specified SplashScreen or WaitForm descendant.
ShowForm(Form, Type, Boolean, Boolean, Boolean, SplashFormStartPosition, Point, Int32, Boolean, ParentFormState, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant.
ShowForm(Form, Type, Boolean, Boolean, Boolean, Boolean) static Creates and displays the specified SplashScreen or WaitForm descendant, centering it against another form. The method's parameter allows you to specify whether the splash form is displayed using the glow effect.
ShowForm(Form, Type, Boolean, Boolean, Boolean, Int32) static Creates the specified SplashScreen or WaitForm descendant and displays it after a delay, centering it against another form. The method's parameter allows you to suppress an exception that is thrown if another splash form has already been opened.
ShowForm(UserControl, Type, Boolean, Boolean) static Creates and displays the specified WaitForm, centering it against the form containing the specified UserControl.
ShowForm(UserControl, Type, Boolean, Boolean, ParentFormState) static Creates and displays the specified WaitForm, centering it against the form containing the specified UserControl. The method's parameter allows you to disable this form while the splash form is displayed.
ShowForm(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point) static Creates and displays the specified WaitForm, allowing you to manually position it.
ShowForm(UserControl, Type, Boolean, Boolean, SplashFormStartPosition, Point, ParentFormState) static Creates and displays the specified WaitForm, allowing you to manually position it. The method's parameter allows you to disable the parent form while the splash form is displayed.
ShowImage(SvgImage) static Displays a vector image as a splash form, centering the image against your application's main form.
ShowImage(SvgImage, Boolean) static Displays a vector image with an optional fade in effect.
ShowImage(SvgImage, Boolean, Boolean) static Displays a vector image as a splash form with optional fade-in and fade-out effects.
ShowImage(SvgImage, Boolean, Boolean, ICustomImagePainter) static Displays 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) static Displays a splash form that contains a vector image. Allows you to manually arrange this splash form.
ShowImage(SvgImage, Boolean, Boolean, SplashFormStartPosition, Point, ICustomImagePainter) static Displays 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, ICustomImagePainter, Int32) static Creates 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, Size) static Resizes the target vector image and shows it as a splash form.
ShowImage(SvgImage, Size, Boolean) static Resizes an image and shows it as a splash form with an optional fade-in effect.
ShowImage(SvgImage, Size, Boolean, Boolean) static Displays 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, Boolean, ICustomImagePainter) static Displays 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) static Displays 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, SplashFormStartPosition, Point, ICustomImagePainter) static Displays 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, ICustomImagePainter, Int32) static Creates 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(Image) static Displays an image as a splash form, centering the image against your application's main form.
ShowImage(Image, Boolean) static Displays an image as a splash form, centering the image against your application's main form.
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, 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) 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, 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, 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, Int32, Boolean) static Displays an image as a splash form. This member supports the internal infrastructure, and is not intended to be used directly from your code.
ShowOverlayForm(Control) static Shows an Overlay Form with the default options over the specified control.
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>) static Shows an Overlay Form with the specified options over the specified control.
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

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also