覆盖表单

---

立即下载DevExpress WinForms

覆盖表单是执行以下操作的半透明启动屏幕：

• 覆盖控件或表单
• 防止用户与重叠控件进行交互
• 覆盖控件，即使它更改其大小或在屏幕上的位置
• 在单独的线程中运行，并且不阻塞主线程和操作线程
• 允许您在重叠控件上显示自定义消息和按钮

注意：运行Overlay Form module in the XtraEditors MainDemo来查看正在使用的表单，单击功能区中的Open Solution获取源代码。

显示覆盖表单

调用ShowOverlayForm(Control) 方法来在控件或表单上显示覆盖表单，该方法返回一个句柄，您可以将其传递给 CloseOverlayForm(IOverlaySplashScreenHandle)方法来关闭表单。

下面的代码显示在应用程序执行长时间运行的操作时如何在当前表单上显示覆盖表单。

C#：

using DevExpress.XtraSplashScreen;
//...
IOverlaySplashScreenHandle ShowProgressPanel() {
return SplashScreenManager.ShowOverlayForm(this);
}
void CloseProgressPanel(IOverlaySplashScreenHandle handle) {
if(handle != null)
SplashScreenManager.CloseOverlayForm(handle);
}
//...
IOverlaySplashScreenHandle handle = null;
try {
handle = ShowProgressPanel();
// Launch a long-running operation while
// the Overlay Form overlaps the current form.
}
finally {
CloseProgressPanel(handle);
}

VB.NET ：

Imports DevExpress.XtraSplashScreen
'...
Private Function ShowProgressPanel() As IOverlaySplashScreenHandle
Dim handle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(Me)
Return handle
End Function

Private Sub CloseProgressPanel(ByVal handle As IOverlaySplashScreenHandle)
If handle IsNot Nothing Then SplashScreenManager.CloseOverlayForm(handle)
End Sub
'...
Dim Handle As IOverlaySplashScreenHandle = Nothing
Try
Handle = ShowProgressPanel()
'Launch a long-running operation while
'the Overlay Form overlaps the main form.
Finally
CloseProgressPanel(Handle)
End Try

警告：您只能在已初始化（创建其句柄）的控件/表单上显示覆盖表单，否则将抛出，请参见 。

叠加表单手柄

您也可以使用句柄的Close()方法来关闭叠加表单。

 显示叠加表单时，聚焦控件将失去焦点，当Overlay Form关闭时，此控件将重新获得焦点。QueueFocus(Control)和QueueFocus(IntPtr)方法允许您指定在关闭Overlay Form时应该聚焦的控件，传递来防止所有控件都有焦点。

您也可以使用QueueCloseUpAction(Action)方法来指定当Overlay Form关闭时应该执行的动作。

C#：

void ReloadData() {
using(var handle = SplashScreenManager.ShowOverlayForm(gridControl)) {
handle.QueueFocus(IntPtr.Zero);
ReloadDataCore();
}
}

VB.NET ：

Private Sub ReloadData()
Using handle = SplashScreenManager.ShowOverlayForm(gridControl)
handle.QueueFocus(IntPtr.Zero)
ReloadDataCore()
End Using
End Sub

自定义覆盖表单

ShowOverlayForm(Control, OverlayWindowOptions方法允许您显示具有以下参数的覆盖表单：

• StartupDelay ——显示表单之前的延迟。
• BackColor —— 背景颜色。
• Opacity —— 不透明表单。
• FadeIn, FadeOut —— 用于显示和隐藏表单的淡入淡出效果。
• AnimationType —— 动画的类型（等待指示符）：
  • Image ——旋转的图像，默认图像取决于皮肤。 使用ImageSize属性指定默认图像的大小，默认图像大小取决于重叠控件的大小，Image属性指定一个自定义图像。
    RotationParameters属性指定旋转周期和单旋转帧数。
  • Line —— 使用LineAnimationParameters属性指定点数，点的大小以及点之间的距离。
• DisableInput——重叠表单是否接收焦点并禁用重叠控件上的用户输入，关闭叠加表单后，它将焦点返回到控件。
• CustomPainter —— 一个用于绘制表单的OverlayWindowPainterBase后代。
• SkinName —— 应用于表单的skin名称，默认的等待指示器，淡入淡出效果和颜色取决于皮肤，默认外观对应于重叠控件的外观
• UseDirectX —— 指定是否使用DirectX渲染覆盖表单，要将DirectX用于所有兼容的DevExpress控件，请在Project Settings中启用Use DirectX选项。

所有这些参数都是可选的，如果省略参数，则使用默认值，不带选项的ShowOverlayForm(Control)方法使用静态（在VB中共享）默认选项。

下面的代码显示了如何显示带有自定义参数的覆盖表单。

C#：

using DevExpress.XtraSplashScreen;

OverlayWindowOptions options = new OverlayWindowOptions(
startupDelay: 1000,
backColor: Color.Red,
opacity: 0.5,
fadeIn: false,
fadeOut: false,
imageSize: new Size(64, 64)
);
IOverlaySplashScreenHandle handle1 = SplashScreenManager.ShowOverlayForm(gridControl1, options);

IOverlaySplashScreenHandle handle2 = SplashScreenManager.ShowOverlayForm(
owner: gridControl1,
startupDelay: 1000,
backColor: Color.Red,
opacity: 127,
fadeIn: false,
fadeOut: false,
imageSize: new Size(64, 64)
);

VB.NET ：

Imports DevExpress.XtraSplashScreen

Dim options As New OverlayWindowOptions(
startupDelay:=1000,
backColor:=Color.Red,
opacity:=0.5,
fadeIn:=False,
fadeOut:=False,
imageSize:=New Size(64, 64)
)
Dim formHandle1 As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(gridControl1, options)

Dim formHandle2 As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(
owner:=gridControl1,
startupDelay:=1000,
backColor:=Color.Red,
opacity:=127,
fadeIn:=False,
fadeOut:=False,
imageSize:=New Size(64, 64)
)

自定义Painter

您可以按以下方式呈现重叠表单：

• 继承自OverlayWindowPainterBase类
• 重写Draw方法
• 将创建的对象作为参数传递给ShowOverlayForm方法

下面的代码段显示了如何显示自定义消息，如下图所示：

C#：

using DevExpress.XtraSplashScreen;
using DevExpress.Utils.Drawing;
using System.Drawing;
//...
class CustomOverlayPainter : OverlayWindowPainterBase
{
// Defines the string’s font.
static readonly Font drawFont;
static CustomOverlayPainter() {
drawFont = new Font("Tahoma", 18);
}
protected override void Draw(OverlayWindowCustomDrawContext context)
{
//The Handled event parameter should be set to true.
//to disable the default drawing algorithm.
context.Handled = true;
//Provides access to the drawing surface.
GraphicsCache cache = context.DrawArgs.Cache;
//Adjust the TextRenderingHint option
//to improve the image quality.
cache.TextRenderingHint = System.Drawing.Text.TextRenderingHint.AntiAlias;
//Overlapped control bounds.
Rectangle bounds = context.DrawArgs.Bounds;
//Draws the default background.
context.DrawBackground();
//Specify the string that will be drawn on the Overlay Form instead of the wait indicator.
String drawString = "Please wait...";
//Get the system's black brush.
Brush drawBrush = Brushes.Black;
//Calculate the size of the message string.
SizeF textSize = cache.CalcTextSize(drawString, drawFont);
//A point that specifies the upper-left corner of the rectangle where the string will be drawn.
PointF drawPoint = new PointF(
bounds.Left + bounds.Width / 2 - textSize.Width / 2,
bounds.Top + bounds.Height / 2 - textSize.Height / 2
);
//Draw the string on the screen.
cache.DrawString(drawString, drawFont, drawBrush, drawPoint);
}
}
//...
IOverlaySplashScreenHandle handle = SplashScreenManager.ShowOverlayForm(this, customPainter: new CustomOverlayPainter());

VB.NET ：

Imports DevExpress.Utils.Drawing
Imports DevExpress.XtraSplashScreen
Imports System.Drawing
'...
Class CustomOverlayPainter
Inherits OverlayWindowPainterBase
'Defines the string’s font.
Shared ReadOnly drawFont As Font

Shared Sub New()
drawFont = New Font("Tahoma", 18)
End Sub

Protected Overrides Sub Draw(context As OverlayWindowCustomDrawContext)
'The Handled event parameter should be set to true
'to disable the default drawing algorithm.
context.Handled = True
'Provides access to the drawing surface.
Dim cache As GraphicsCache = context.DrawArgs.Cache
'Adjust the TextRenderingHint option
’to improve the image quality.
cache.TextRenderingHint = System.Drawing.Text.TextRenderingHint.AntiAlias
'Overlapped control bounds.
Dim bounds As Rectangle = context.DrawArgs.Bounds
'Draws the default background.
context.DrawBackground()
'Create the string to draw.
Dim drawString As String = "Please wait..."
'Get the system black brush.
Dim drawBrush As Brush = Brushes.Black
'Calculate the size of the message string.
Dim textSize As SizeF = cache.CalcTextSize(drawString, drawFont)
'A point that specifies the upper-left corner of the rectangle where the string should be drawn.
Dim drawPoint As PointF = New PointF(bounds.Left + bounds.Width / 2 - textSize.Width / 2, bounds.Top + bounds.Height / 2 - textSize.Height / 2)
'Draw the string on the screen.
cache.DrawString(drawString, drawFont, drawBrush, drawPoint)
End Sub
End Class
'...
Dim handle As IOverlaySplashScreenHandle = SplashScreenManager.ShowOverlayForm(Me, customPainter:=New CustomOverlayPainter())