FineUI小技巧（4）关闭窗体那些事

2022-07-02 00:28:08

前言

FineUI中的Window控件常用作选择、新增或编辑内容。而关闭Window控件却有很多技巧，了解这些技巧有助于项目的快速开发。

如何关闭Window控件

第一个问题就是如何关闭Window控件，最明显的方式就是右上角的关闭图标了。总的说来，有三种方式：

ESC按键（在Window控件所在页面获取焦点的情况下，按下键盘的ESC将会关闭当前激活窗体）
窗体右上角的关闭图标
用户自定义的关闭按钮

前两种方式自不必说，那么如何自定义关闭按钮呢？有两种做法：

按钮禁用回发，在页面初始化时注册关闭脚本

 <f:Button ID="btnHideInClient" CssClass="inline" Text="隐藏窗体（客户端代码）" EnablePostBack="false"

             runat="server">

 </f:Button>

 protected void Page_Load(object sender, EventArgs e)

 {

     if (!IsPostBack)

     {

         btnHideInClient.OnClientClick = Window2.GetHideReference();

     }

 }

按钮回发，在回发事件中设置窗体Hidden属性，

 <f:Button ID="btnHideInServer" Text="隐藏窗体（服务端代码）" runat="server" OnClick="btnHideInServer_Click">

 </f:Button>

 protected void btnHideInServer_Click(object sender, EventArgs e)

 {

     Window2.Hidden = true;

 }

或者注册关闭脚本：

 protected void btnHideInServer_Click(object sender, EventArgs e)

 {

     PageContext.RegisterStartupScript(Window2.GetHideReference());

 }

当然，这里按钮是和Window控件在同样一个页面的。

对于另一种常见情况，也即启用IFrame的Window控件，位于IFrame页面内的按钮如何关闭父页面中的这个Window控件呢？

显然，我们无法在IFrame页面内获取Window控件的实例！

没关系，FineUI提供了ActiveWindow类来处理这个常见问题：

 protected void btnSaveContinue_Click(object sender, EventArgs e)

 {

     PageContext.RegisterStartupScript(ActiveWindow.GetHideReference());

 }

关闭窗体的方式

前面提到的关闭窗体，只是简单的关闭，并未做任何其他处理。其实FineUI提供了三种关闭窗体的方式：

直接关闭：也就是前面提到的 GetHideReferene 方法返回的脚本
关闭窗体，然后回发窗体所在的页面，触发Window控件的Close事件：可以使用内置的 GetHidePostBackReference 方法
关闭窗体，然后刷新窗体所在的页面：可以使用内置的 GetHideRefreshReference 方法

再回到前面介绍的"如何关闭窗体"，显然前两种关闭方法（ESC，右上角关闭图标）无法使用 GetHide***Reference 方法，怎么办？

FineUI同时为Window控件提供了 CloseAction 属性，可能的值为 Hide，HidePostBack 和 HideRefresh，分别对应上述方法。

来看一个例子：

初始显示

点击右上角关闭图标，触发了Close事件

这个行为是由Window控件的CloseAction属性控制的，来看下控件标签：

 <f:Window ID="Window2" Width="650px" Height="300px" Icon="TagBlue" Title="窗体" Hidden="true"

     EnableMaximize="true" EnableCollapse="true" runat="server" EnableResize="true"

     IsModal="false" CloseAction="HidePostBack" OnClose="Window2_Close" Layout="Fit">

 </f:Window>

后台的事件处理代码：

 protected void Window2_Close(object sender, WindowCloseEventArgs e)

 {

     Alert.ShowInTop("窗体被关闭了。参数：" + (String.IsNullOrEmpty(e.CloseArgument) ? "无" : e.CloseArgument));

 }

CloseAction无法定义返回参数，所以这里显示"无"！

点击页面上的"隐藏窗体，带回发参数"，触发了Close 事件，此时的页面显示

这个按钮的响应脚本是在页面初始化时注册的，如下所示（注意参数是如何设进去的）：

 protected void Page_Load(object sender, EventArgs e)

 {

     if (!IsPostBack)

     {

         btnHideInClient2.OnClientClick = Window2.GetHidePostBackReference("btnHideInClient2");

     }

 }

同样，对于启用IFrame的Window控件，其IFrame内按钮的关闭窗体处理，对应于ActiveWindow的几个方法：

ActiveWindow.GetHideReference
ActiveWindow.GetHidePostBackReference
ActiveWindow.GetHideRefreshReference

关闭窗体的确认对话框

这个特性可能很多人都不知道，不过存在很强的实用性。

简单描述：启用IFrame的Window控件，如果IFrame页面内任意表单字段发生改变，则在关闭窗体时弹出确认框。

目的是防止用户在输入表单内容后，还没来的及保存，一个误操作把弹出窗体关了。

页面初始显示
在"数字输入框"内输入任意值，然后点击右上角的关闭图标，弹出确认对话框
清空 "数字输入框"内的值（也即是还原到其初始状态），然后点击右上角的关闭图标，则直接关闭窗体

上述操作是由Window控件的 EnableConfirmOnClose 属性控制（默认为false），下面是这个Window实例的标签定义：

 <f:Window ID="Window1" Hidden="true" EnableIFrame="true" runat="server" EnableConfirmOnClose="true"

     EnableMaximize="true" EnableResize="true" Height="450px" Width="800px" Title="窗体一">

 </f:Window>

对于上述页面中的"关闭"按钮，行为和右上角的关闭图标一致，不过这种一致性也是认为控制的，来看看"关闭"按钮的脚本：

 protected void Page_Load(object sender, EventArgs e)

 {

     if (!IsPostBack)

     {

         btnClose.OnClientClick = ActiveWindow.GetConfirmHideReference();

     }

 }

本章小结

本篇文章介绍了三种关闭Window控件的方法（ESC、关闭图标、自定义），以及三种FineUI定义的处理方式（隐藏、隐藏后回发、隐藏后刷新）。对于IFrame内的关闭按钮，FineUI提供了ActiveWindow来生成关闭脚本。同时还介绍了一个FineUI内置的属性 EnableConfirmOnClose ，用来控制是否弹出关闭窗体的确认对话框。