Class SplashPanel

The SplashPanel class is a System.Windows.Forms.Panel derived class that will let you design custom splash screens within the Form's designer. The SplashPanel can take multiple child controls that can be used to display information or collect information from the user.

Inheritance

System.Object

SplashPanel

SplashControl.DefaultPanel

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class SplashPanel : Panel, ISplashWrapperFormListener

Remarks

The SplashPanel class is a panel class that has uses beyond the typical splash screen. It can be used to create non obtrusive message boxes such as the Microsoft MSN messenger (as of MSN Messenger version 3.0 ) message window that informs user that a new mail has arrived. These kind of messages boxes are made very easy to create and use with the SplashPanel class.

To design a custom splash, drag and drop it off the toolbox into a Form during design-time. Then populate it with appropriate Controls just like you would any other Panel. The splash panel can also appear in an animated manner on the screen. The startup position of the splash panel can also be specified through the DesktopAlignment property.

The Splash Panel itself can be set to have appealing gradient and pattern backgrounds by specifying the BackgroundColor property.

When you are ready to display the splash, call this ShowSplash(Point, Form, Boolean) method. This will show the splash panel at the specified location.

The SplashPanel uses a System.Windows.Forms.Timer internally to automatically close the Splash screen after the set interval is elapsed. This behavior can be changed by setting the SplashPanel's TimerInterval property to -1. The SplashPanel can be explicitly closed by calling HideSplash(SplashCloseType, Int32)

The SplashPanel also raises the BeforeSplash, SplashDisplayed and SplashClosing events that you can handle. You could for example set the focus on a Control within the SplashPanel in the SplashDisplayed event handler.

Examples

// Create the splash panel
this.splashPanel1 = new SplashPanel();
this.button1 = new Button();
// The animation speed
this.splashPanel1.AnimationSpeed = 10;
// The background
this.splashPanel1.BackgroundColor = new BrushInfo(Syncfusion.Drawing.GradientStyle.Vertical, System.Drawing.SystemColors.HighlightText, System.Drawing.SystemColors.Highlight);
// The border style
this.splashPanel1.BorderStyle = System.Windows.Forms.Border3DStyle.Bump;
// The child controls - added through the designer
this.splashPanel1.Controls.AddRange(new System.Windows.Forms.Control[] { this.linkLabel1});
// The startup location for the splash panel
this.splashPanel1.DesktopAlignment = SplashPanel.SplashAlignment.SystemTray;
// Specifies whether the window should appear animated
this.splashPanel1.ShowAnimation = true;
// The interval for which the panel is to be displayed
this.splashPanel1.TimerInterval = 5000;
this.button1.Click += new System.EventHandler(this.button1_Click);

' Create the splash panel
Me.splashPanel1 = New SplashPanel()
Me.button1 = New Button()
' The animation speed
Me.splashPanel1.AnimationSpeed = 10
' The background
Me.splashPanel1.BackgroundColor = New BrushInfo(Syncfusion.Drawing.GradientStyle.Vertical, System.Drawing.SystemColors.HighlightText, System.Drawing.SystemColors.Highlight)
' The border style
Me.splashPanel1.BorderStyle = System.Windows.Forms.Border3DStyle.Bump
' The child controls - added through the designer
Me.splashPanel1.Controls.AddRange(New System.Windows.Forms.Control() {Me.linkLabel1})
' The startup location for the splash panel
Me.splashPanel1.DesktopAlignment = SplashPanel.SplashAlignment.SystemTray
' Specifies whether the window should appear animated
Me.splashPanel1.ShowAnimation = True
' The interval for which the panel is to be displayed
Me.splashPanel1.TimerInterval = 5000
AddHandler Me.button1.Click, New System.EventHandler(AddressOf button1_Click)

Constructors

SplashPanel()

Initializes a new instance of the SplashPanel class.

Declaration

public SplashPanel()

Remarks

The default value for the TimerInterval is set to 5000 milli seconds. The splash panel has animation turned and by default will appear in the middle of the screen.

Fields

AnimationInterval

Used for animation.

Declaration

public static int AnimationInterval

Field Value

Type
System.Int32

Properties

AllowMove

Gets or sets a value indicating whether the AllowMove property allows the user to click within the SplashPanel and move the SplashPanel on the screen.

Declaration

public bool AllowMove { get; set; }

Property Value

Type
System.Boolean

AllowResize

Gets or sets a value indicating whether the AllowResize property allows the user to resize the SplashPanel. Resize handles will be displayed when the user moves the mouse near the border of the SplashPanel.

Declaration

public bool AllowResize { get; set; }

Property Value

Type
System.Boolean

Remarks

The SplashPanel can be resized by the user if AllowResize is set to true.

AnimationDirection

Gets or sets the Animation direction for the SplashPanel.

Declaration

public AnimationDirection AnimationDirection { get; set; }

Property Value

Type
AnimationDirection

AnimationSpeed

Gets or sets the speed at which the animation unfolds on the screen and the SplashPanel becomes visible.

Declaration

public int AnimationSpeed { get; set; }

Property Value

Type
System.Int32

Remarks

To achieve the best animation effect, the animation speed should be set relative with respect to the height and width of the SplashPanel. The value for the animation speed is restricted to be between 5 and 50.

AnimationSteps

Gets or sets the number of pixels at which the animation unfolds in sliding style.

Declaration

public int AnimationSteps { get; set; }

Property Value

Type
System.Int32

Autohide

Gets or sets a value indicating whether the SplashPanel should auto hide.

Declaration

public bool Autohide { get; set; }

Property Value

Type
System.Boolean

BackColor

Gets or sets the backcolor for the control.

Declaration

public Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

BackgroundColor

Gets or sets the background color and other styles for the SplashPanel.

Declaration

public BrushInfo BackgroundColor { get; set; }

Property Value

Type
BrushInfo

Remarks

The SplashPanel provides this property to enable specialized custom gradient backgrounds for the splash screens you create.

BeforeTouchSize

Gets or Sets the Control size before touch enabled.

Declaration

public Size BeforeTouchSize { get; set; }

Property Value

Type
System.Drawing.Size

BorderStyle

Gets or sets the 3D border for the SplashPanel.

Declaration

public Border3DStyle BorderStyle { get; set; }

Property Value

Type
System.Windows.Forms.Border3DStyle

Remarks

The SplashPanel class provides 3D border styles for its borders. You can set the border style for the SplashPanel to any of the values supported by the System.Windows.Forms.Border3DStyle enumeration. Setting the BorderStyle property to System.Windows.Forms.Border3DStyle.Adjust results in no border being visible. The options included are as follows RaisedOuter, SunkenOuter, RaisedInner, SunkenInner, Raised, Etched, Bump, Sunken, Adjust and Flat.

BorderType

Gets or sets the type of border for the SplashPanel.

Declaration

public SplashBorderType BorderType { get; set; }

Property Value

Type
SplashBorderType

CloseOnClick

Gets or sets a value indicating whether the CloseOnClick property closes the SplashPanel. If the user clicks inside the SplashPanel and moves the SplashPanel (this is allowed if the AllowMove property is set to true), the SplashPanel will not be closed. The SplashPanel will not be closed if the click is on a Child control.

Declaration

public bool CloseOnClick { get; set; }

Property Value

Type
System.Boolean

Remarks

The SplashPanel will be closed if CloseOnClick set to true and the user clicks the SplashPanel.

CloseOnLostFocus

Gets or Sets the focus state of the SplashPanel

Declaration

public bool CloseOnLostFocus { get; set; }

Property Value

Type
System.Boolean

DesktopAlignment

Gets or sets the desktop alignment of the splash image.

Declaration

public SplashAlignment DesktopAlignment { get; set; }

Property Value

Type
SplashAlignment

Remarks

SplashAlignment lists the possible values for this property. It includes the following options SystemTray, Center, LeftTop, LeftBottom, RightTop, RightBottom and Custom.

DiscreetLocation

Gets or sets the location to display the splash window. This is a System.Drawing.Point value that is in screen coordinates.

Declaration

public Point DiscreetLocation { get; set; }

Property Value

Type
System.Drawing.Point

Remarks

You can display a discrete location for the SplashPanel to be displayed at. The location parameter passed to the constructor of SplashPanel is used to set this value initially.

EnableTouchMode

Gets or Sets the touchmode for the SplashPanel.

Declaration

public bool EnableTouchMode { get; set; }

Property Value

Type
System.Boolean

FormIcon

Gets or sets the icon for the SplashPanel when displayed in the Taskbar.

Declaration

public Icon FormIcon { get; set; }

Property Value

Type
System.Drawing.Icon

MarqueeDirection

Gets or sets the marquee direction for the SplashPanel.

Declaration

public SplashPanelMarqueeDirection MarqueeDirection { get; set; }

Property Value

Type
SplashPanelMarqueeDirection

Remarks

If the SplashPanel SlideStyle is set as marquee and the MarqueeDirection is set as LeftToRight, the marquee will traverse the screen from left to right. If the SplashPanel SlideStyle is set as marquee and the MarqueeDirection is set as RightToLeft, the marquee will traverse the screen from right to left.

MarqueePosition

Gets or sets the marquee position for the SplashPanel.

Declaration

public MarqueePosition MarqueePosition { get; set; }

Property Value

Type
MarqueePosition

ShowAnimation

Gets or sets a value indicating whether the SplashPanel should be animated.

Declaration

public bool ShowAnimation { get; set; }

Property Value

Type
System.Boolean

Remarks

Set this property to true if you want the SplashPanel to appear in an animated manner.

ShowAsTopMost

Gets or sets a value indicating whether the SplashPanel is shown as a TopMost window when displayed.

Declaration

public bool ShowAsTopMost { get; set; }

Property Value

Type	Description
System.Boolean	True if the SplashPanel is displayed as a TopMost window; false otherwise. The default is true.

Remarks

Displaying the SplashPanel as a TopMost window makes the SplashPanel appear on top of all other windows. If this property is false and the SplashPanel is displayed in non modal mode, the SplashPanel might be hidden by the Form displaying the SplashPanel. If you want the SplashPanel to be the TopMost window with respect to the application/Form displaying it only, you should display the SplashPanel modally with this property set to false.

ShowInTaskbar

Gets or sets a value indicating whether the SplashPanel is to be shown in the Taskbar.

Declaration

public bool ShowInTaskbar { get; set; }

Property Value

Type
System.Boolean

SlideStyle

Gets or sets the SlideStyle for the SplashPanel.

Declaration

public SlideStyle SlideStyle { get; set; }

Property Value

Type
SlideStyle

Remarks

The options included are as follows Horizontal, Vertical, LeftToRight, RightToLeft, TopToBottom, BottomToTop and FadeIn. The ShowAnimation property must be set to 'True'.

SplashForm

Gets the splash form.

Declaration

public Form SplashForm { get; }

Property Value

Type	Description
System.Windows.Forms.Form	The splash form.

SplashParent

Gets or sets a value indicating SplashPanel can take a class that implements ISplashParent as its parent for notification purposes.

Declaration

public ISplashParent SplashParent { get; set; }

Property Value

Type	Description
ISplashParent	An instance that implements ISplashParent.

Remarks

You can implement the ISplashParent interface in your classes and set the SplashParent property of the SplashPanel to your class to get notifications.

SuspendAutoCloseWhenMouseOver

Gets or sets a value indicating whether the SplashPanel should not be closed when the mouse is over it.

Declaration

public bool SuspendAutoCloseWhenMouseOver { get; set; }

Property Value

Type
System.Boolean

Text

Gets or sets the text when displayed in the Taskbar.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

TimerInterval

Gets or sets the period of time the splash window should be visible for.

Declaration

public int TimerInterval { get; set; }

Property Value

Type
System.Int32

Remarks

The unit of measurement for this is in milliseconds. The default value is 5000 milliseconds which translates to 5 seconds.

The time is taken into account after the window appears on the screen.

TransparentColor

Gets or sets the transparent color for the background.

Declaration

public Color TransparentColor { get; set; }

Property Value

Type
System.Drawing.Color

Methods

ApplyScaleToControl(Single)

Method to Apply scale value to the SplashPanel.

Declaration

public void ApplyScaleToControl(float scaleFactor)

Parameters

Type	Name	Description
System.Single	scaleFactor	Indicates the Scale factor.

Dispose(Boolean)

Cleans up any resources being used.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Bool value

DrawBackground(Graphics)

Draws the background of the panel using the information in the BackgroundColor property.

Declaration

protected virtual void DrawBackground(Graphics g)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	The graphics object to draw on.

Remarks

Override this virtual function if you want to draw a different background on change the way the drawing is done.

HideSplash()

Hides the SplashPanel.

Declaration

public virtual void HideSplash()

Remarks

Call this method to Hide a SplashPanel window that is being displayed currently. The SplashPanel will be closed with the SplashCloseType set to Canceled. This method actually invokes the overloaded version that takes a SplashCloseType as the parameter.

HideSplash(SplashCloseType)

Hides a SplashPanel with the specified SplashCloseType mode.

Declaration

public virtual void HideSplash(SplashCloseType splashCloseType)

Parameters

Type	Name	Description
SplashCloseType	splashCloseType	Indicates the SplashCloseType value.

HideSplash(SplashCloseType, Int32)

Hides a SplashPanel with the specified SplashCloseType mode.

Declaration

public virtual void HideSplash(SplashCloseType splashCloseType, int delayInMilliseconds)

Parameters

Type	Name	Description
SplashCloseType	splashCloseType	Indicates the SplashCloseType value.
System.Int32	delayInMilliseconds	The time period for which the close should be delayed.

Remarks

This method will close the SplashPanel when it is being displayed. It invokes IsShowing() to ascertain that the SplashPanel is being displayed before any further action is taken.

The method will have no effect if the SplashPanel is not currently being displayed.

IsShowing()

Indicates whether the SplashPanel is currently displayed.

Declaration

public bool IsShowing()

Returns

Type	Description
System.Boolean	True indicates SplashPanel is displayed; false otherwise.

Remarks

The SplashPanel considered visible if the Syncfusion.Windows.Forms.Tools.SplashPanel.SplashWrapperForm that embeds this SplashPanel is visible. The HideSplash(SplashCloseType, Int32) method uses this method to ascertain if the SplashPanel is indeed being displayed.

OnBeforeSplash(CancelEventArgs)

Raises the BeforeSplash event.

Declaration

protected virtual void OnBeforeSplash(CancelEventArgs args)

Parameters

Type	Name	Description
System.ComponentModel.CancelEventArgs	args	A CancelEventArgs that contains the event data.

Remarks

The OnBeforeSplash method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnBeforeSplash in a derived class, be sure to call the base class' OnBeforeSplash method so that registered delegates receive the event.

OnClick(EventArgs)

Raises the System.Windows.Forms.Control.Click event.

Declaration

protected override void OnClick(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	An System.EventArgs that contains the event data.

OnFontChanged(EventArgs)

Font changed

Declaration

protected override void OnFontChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnMouseDown(MouseEventArgs)

Raises the mouse down event.

Declaration

protected override void OnMouseDown(MouseEventArgs mea)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	mea	The System.Windows.Forms.MouseEventArgs instance containing the event data.

OnMouseEnter(EventArgs)

Overrides OnMouseEnter to support SuspendAutoCloseOnMouseOver.

Declaration

protected override void OnMouseEnter(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e	The event data.

OnMouseLeave(EventArgs)

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnMouseMove(MouseEventArgs)

Raises the MouseMove event.

Declaration

protected override void OnMouseMove(MouseEventArgs mea)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	mea	The System.Windows.Forms.MouseEventArgs instance containing the event data.

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

Declaration

protected override void OnMouseUp(MouseEventArgs mea)

Parameters

Type	Name	Description
System.Windows.Forms.MouseEventArgs	mea	The System.Windows.Forms.MouseEventArgs instance containing the event data.

OnPaintBackground(PaintEventArgs)

Overrides OnPaintBackground to paint the user specified BackgroundColor as the background.

Declaration

protected override void OnPaintBackground(PaintEventArgs pe)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	pe	The PaintEventArgs object that has the event data.

OnSizeChanged(EventArgs)

Declaration

protected override void OnSizeChanged(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

OnSplashClosed(SplashClosedEventArgs)

Raises the SplashClosing event.

Declaration

protected virtual void OnSplashClosed(SplashClosedEventArgs args)

Parameters

Type	Name	Description
SplashClosedEventArgs	args	A SplashClosedEventArgs instance containing data pertaining to this event.

Remarks

The OnSplashClosing method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnSplashClosing in a derived class, be sure to call the base class' OnSplashClosing method so that registered delegates receive the event.

OnSplashClosing(CancelEventArgs)

Raises the SplashClosing event.

Declaration

protected virtual void OnSplashClosing(CancelEventArgs args)

Parameters

Type	Name	Description
System.ComponentModel.CancelEventArgs	args	The System.ComponentModel.CancelEventArgs instance containing the event data.

OnSplashDisplayed(EventArgs)

Raises the SplashDisplayed event.

Declaration

protected virtual void OnSplashDisplayed(EventArgs args)

Parameters

Type	Name	Description
System.EventArgs	args	An EventArgs instance containing data pertaining to this event.

Remarks

The OnSplashDisplayed method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnSplashDisplayed in a derived class, be sure to call the base class' OnSplashDisplayed method so that registered delegates receive the event.

OnSplashMouseEnter(EventArgs)

Raises the SplashMouseEnter event.

Declaration

protected void OnSplashMouseEnter(EventArgs args)

Parameters

Type	Name	Description
System.EventArgs	args	An EventArgs instance containing data pertaining to this event.

Remarks

The OnSplashMouseEnter method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnSplashMouseEnter in a derived class, be sure to call the base class' OnSplashMouseEnter method so that registered delegates receive the event.

OnSplashMouseLeave(EventArgs)

Raises the SplashMouseLeave event.

Declaration

protected void OnSplashMouseLeave(EventArgs args)

Parameters

Type	Name	Description
System.EventArgs	args	An EventArgs instance containing data pertaining to this event.

Remarks

The OnSplashMouseLeave method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnSplashMouseLeave in a derived class, be sure to call the base class' OnSplashMouseLeave method so that registered delegates receive the event.

RaiseBeforeSplashEvent()

Invokes the OnBeforeSplash(CancelEventArgs) method to raise the BeforeSplash event.

Declaration

protected bool RaiseBeforeSplashEvent()

Returns

Type	Description
System.Boolean	The value set for the System.ComponentModel.CancelEventArgs object used by the event data. A return value of true means the SplashPanel will not be displayed.

Remarks

This method creates a System.ComponentModel.CancelEventArgs object to use as the event data and invokes the OnBeforeSplash(CancelEventArgs) method.

RaiseSplashClosedEvent(SplashClosedEventArgs)

Raises the SplashCosed event.

Declaration

protected void RaiseSplashClosedEvent(SplashClosedEventArgs args)

Parameters

Type	Name	Description
SplashClosedEventArgs	args	EventArgs that contains the event data.

RaiseSplashClosingEvent()

Invokes the OnBeforeSplash(CancelEventArgs) method to raise the BeforeSplash event.

Declaration

protected bool RaiseSplashClosingEvent()

Returns

Type	Description
System.Boolean	The value set for the System.ComponentModel.CancelEventArgs object used by the event data. A return value of true means the SplashPanel will not be displayed.

Remarks

This method creates a System.ComponentModel.CancelEventArgs object to use as the event data and invokes the OnBeforeSplash(CancelEventArgs) method.

RaiseSplashDisplayedEvent()

Raises the SplashDisplayed event.

Declaration

protected void RaiseSplashDisplayedEvent()

RefreshRegionFromImage()

Refreshes the region from BackgroundImage.

Declaration

public void RefreshRegionFromImage()

RestoreAutoCloseMode()

Restores the auto closing of the SplashPanel.

Declaration

public void RestoreAutoCloseMode()

Show()

Displays the SplashPanel.

Declaration

public void Show()

ShowDialogSplash(Point, Form)

Overloaded. Displays the SplashPanel as a modal dialog.

Declaration

public DialogResult ShowDialogSplash(Point location, Form ownerForm)

Parameters

Type	Name	Description
System.Drawing.Point	location	The location at which the SplashPanel is to be displayed.
System.Windows.Forms.Form	ownerForm	The form that will embed the SplashForm. This can be null.

Returns

Type	Description
System.Windows.Forms.DialogResult	The DialogResult value.

ShowDialogSplash(Form)

Displays the SplashPanel as a modal dialog.

Declaration

public DialogResult ShowDialogSplash(Form ownerForm)

Parameters

Type	Name	Description
System.Windows.Forms.Form	ownerForm	Indicates the owner form of the SplashPanel.

Returns

Type	Description
System.Windows.Forms.DialogResult	Retruns the DialogResult value.

ShowSplash()

Displays the SplashPanel.

Declaration

public void ShowSplash()

ShowSplash(Point, Form, Boolean)

Displays the SplashPanel at the specified location.

Declaration

public virtual void ShowSplash(Point location, Form ownerForm, bool disableOwner)

Parameters

Type	Name	Description
System.Drawing.Point	location	A point in screen coordinates. The value can be Point.Empty.
System.Windows.Forms.Form	ownerForm	The form that will embed the SplashForm. This can be null.
System.Boolean	disableOwner	Indicates whether the owner form is to be disabled.

SplashFormClosedNotify()

This methods is an implementation of the Syncfusion.Windows.Forms.Tools.ISplashWrapperFormListener interface for receiving notification from the Syncfusion.Windows.Forms.Tools.SplashPanel.SplashWrapperForm when the window is closed.

Declaration

public void SplashFormClosedNotify()

Remarks

The SplashClosing event is raised in response to this method being invoked.

SplashFormDisplayedNotify()

This method implements the Syncfusion.Windows.Forms.Tools.ISplashWrapperFormListener interface to receive notification from the Syncfusion.Windows.Forms.Tools.SplashPanel.SplashWrapperForm when the Splash window has been displayed.

Declaration

public void SplashFormDisplayedNotify()

Remarks

The SplashPanel receives notification from the Syncfusion.Windows.Forms.Tools.SplashPanel.SplashWrapperForm that actually displays this SplashPanel on the desktop that the SplashPanel has been displayed. This is needed for the SplashPanel to start its internal timer so that the SplashPanel can be closed in the time interval set in TimerInterval.

StartTimer()

Starts the System.Windows.Forms.Timer object that will be used to show the SplashPanel for a specified period of time.

Declaration

protected void StartTimer()

Remarks

Change the TimerInterval property if you want to change the period for which the SplashPanel is displayed.

This method is invoked by SplashFormDisplayedNotify() and you will not need to call this directly.

This method will do nothing if the TimerInterval property is set to -1.

StopTimer()

Stops the timer object that is used to track the appearance of the SplashPanel.

Declaration

protected void StopTimer()

Remarks

This method stops the System.Windows.Forms.Timer and closes the timer object. This is invoked by the Syncfusion.Windows.Forms.Tools.SplashPanel.HandleTimerEvent(System.Object,System.Timers.ElapsedEventArgs) method and you will not need to call this directly.

SuspendAutoCloseMode()

Suspends the auto closing of the SplashPanel after the TimerInterval.

Declaration

public void SuspendAutoCloseMode()

UnWireChildEvents()

Declaration

protected void UnWireChildEvents()

WireChildEvents()

Declaration

protected void WireChildEvents()

WndProc(ref Message)

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
System.Windows.Forms.Message	m

Events

BeforeSplash

Occurs when the splash is about to be shown.

Declaration

public event CancelEventHandler BeforeSplash

Event Type

Type
System.ComponentModel.CancelEventHandler

Remarks

This event provides a way for the user to stop a SplashPanel from being displayed. If you set the System.ComponentModel.CancelEventHandler to be true, the SplashPanel will not be displayed.

You can also access the SplashPanel's Syncfusion.Windows.Forms.Tools.SplashPanel.SplashWrapperForm and make changes to it if you want to do any modifications.

SplashClosed

Occurs when a SplashPanel is closed.

Declaration

public event SplashClosedEventHandler SplashClosed

Event Type

Type
SplashClosedEventHandler

Remarks

Handling this event will tell you whether the splash was closed or canceled by the user. This, in some cases, will then let you know whether or not you should accept changes in the splash.

The delegate for the event is SplashClosedEventHandler.

You could handle this event and do any post SplashPanel displayed processing in there. For example, you have an application that displays non obtrusive message boxes using the SplashPanel class, you can handle this event to check if the user has made any change or selection.

Examples

this.splashPanel1.SplashClosed += new Syncfusion.Windows.Forms.Tools.SplashClosedEventHandler(this.splashPanel1_SplashClosed);
// splashPanel1_SplashClosed event handler
private void SplashPanel_SplashClosed(object sender, SplashClosedEventArgs args)
{
    MessageBox.Show("SplashPanel closed event handler");
}

AddHandler Me.splashPanel1.SplashClosed, New Syncfusion.Windows.Forms.Tools.SplashClosedEventHandler(AddressOf splashPanel1_SplashClosed)
' splashPanel1_SplashClosed event handler
Private Sub SplashPanel_SplashClosed(ByVal sender As Object, ByVal args As SplashClosedEventArgs)
     MessageBox.Show("SplashPanel closed event handler")
End Sub

SplashClosing

Occurs when a SplashPanel is being closed.

Declaration

public event CancelEventHandler SplashClosing

Event Type

Type
System.ComponentModel.CancelEventHandler

Remarks

This event can be handled to prevent a SplashPanel from being closed and also to do custom processing.

SplashDisplayed

Occurs after the SplashPanel has been displayed.

Declaration

public event EventHandler SplashDisplayed

Event Type

Type
System.EventHandler

Remarks

This event informs the handler that the SplashPanel is visible now. You could display a status message or some feedback to the user in another part of the application.

SplashMouseEnter

Occurs when the mouse enters the visible part of the SplashPanel or any of its child controls.

Declaration

public event EventHandler SplashMouseEnter

Event Type

Type
System.EventHandler

Remarks

This event informs that the mouse has entered the SplashPanel.

SplashMouseLeave

Occurs when the mouse leaves the visible part of the SplashPanel or any of its child controls.

Declaration

public event EventHandler SplashMouseLeave

Event Type

Type
System.EventHandler

Remarks

This event informs that the mouse has left the SplashPanel.