搬运工
搬运工

报表应用

 约 2729 字   预计阅读 6 分钟 

报表模板设计完成后，以XML格式存储在数据库、文件或代码中，当用户浏览某张预定义报表时，报表系统会根据报表模板和用户输入的参数动态解析生成一个包含最终数据的遵循一定格式的XML内容，这些内容支持以Excel或Pdf的格式显示。

报表管理

为了实现快速开发，对报表系统进行了封装，提供了报表管理的功能，将报表设计、报表模板XML存储、报表预览打包成一个不需要任何代码就可让用户使用的子系统。

打开主页，点击菜单工作台 -> 报表设计，可以看到所有的报表模板目录，报表模板的增删改查和普通的单实体管理相同。报表模板的XML存储在数据库表cm_rpt中，该表和其它表无任何关联关系，报表设计器可以直接打开和保存到数据库中。

/dt-docs/6%E6%8A%A5%E8%A1%A8/3%E6%8A%A5%E8%A1%A8%E5%BA%94%E7%94%A8/1.png

以下演示报表管理全过程：新增报表模板、报表设计、报表模板XML保存、配置报表菜单、菜单授权、用户浏览报表。

警告
为了减轻服务端压力，报表模板采用模型缓存，所以新增或修改报表模板后，必须更新缓存并重启应用后，才能看到最新的报表预览。 /dt-docs/6%E6%8A%A5%E8%A1%A8/3%E6%8A%A5%E8%A1%A8%E5%BA%94%E7%94%A8/2.png

若报表浏览不是菜单方式提供给用户，而是以交互方式嵌入到某个操作中，需要提供简单代码。

1

Rpt.Show(new RptInfo { Uri = "rpt://Test" }, false, "标题", icon);

报表API

推荐使用报表管理方式来管理报表模板，以菜单配置方式提供报表浏览，尤其同一套系统提供给多个客户，而每个客户又有不同报表需求时，实现相同代码不同配置(数据)。

当然，系统也提供了更加灵活的方式处理报表，这些API涉及负责报表浏览的RptInfo类和负责报表设计的RptDesignInfo类，两类的基类为RptInfoBase。

/dt-docs/6%E6%8A%A5%E8%A1%A8/3%E6%8A%A5%E8%A1%A8%E5%BA%94%E7%94%A8/3.png

RptInfoBase

RptInfoBase类是报表浏览和报表设计的基类，包含报表名称、报表模板路径属性和读取模板内容方法等。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

/// <summary>
/// 报表描述信息
/// 提供报表模板三种方式优先级：
/// 1. 直接提供RptRoot对象，内部使用，如报表编辑时预览
/// 2. 重写 ReadTemplate 方法，模板在其他位置时
/// 3. 默认通过Uri查询模板，支持4种格式：rpt local ms-appx embedded
/// </summary>
public abstract class RptInfoBase
{
    /// <summary>
    /// 获取设置报表模板路径，作为唯一标识，支持4种格式：
    /// <para>cm_rpt表：rpt://模板名称</para>
    /// <para>本地sqlite库：local://库名/模板名称</para>
    /// <para>内容文件：ms-appx:///Dt.UIDemo/Report/模板名称.rpt，android不支持路径中文</para>
    /// <para>嵌入资源：embedded://程序集名/完整路径.模板名称.rpt</para>
    /// </summary>
    public string Uri { get; set; }

    /// <summary>
    /// 获取设置报表名称
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// 读取模板内容，重写可自定义读取模板过程
    /// </summary>
    /// <returns></returns>
    public virtual async Task<string> ReadTemplate()
}

从以上定义可以看出，Uri属性除了支持将报表模板XML存储在数据库表cm_rpt外，还支持将报表模板XML存储在本地库或文件中，文件包括项目内容文件和嵌入资源文件。这些是通过路径前缀区分的rpt:// local:// ms-appx:/// embedded://。

如果以上4个位置都不满足需求，可以重写ReadTemplate方法，返回报表模板XML内容。

RptInfo

报表浏览的API，一般构造RptInfo对象时只需设置Uri和Name属性。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

public static class Rpt
{
    /// <summary>
    /// 打开新窗口显示报表
    /// </summary>
    /// <param name="p_info">报表描述信息</param>
    /// <param name="p_isPdf">报表是否采用Pdf格式</param>
    /// <param name="p_winTitle"></param>
    /// <param name="p_icon">图标</param>
    public static async void Show(RptInfo p_info, bool p_isPdf = false, string p_winTitle = null, Icons p_icon = Icons.折线图)

    /// <summary>
    /// 显示报表对话框
    /// </summary>
    /// <param name="p_info">报表描述信息</param>
    /// <param name="p_isPdf">报表是否采用Pdf格式</param>
    /// <param name="p_title"></param>
    /// <returns>对话框</returns>
    public static async Task<Dlg> ShowDlg(RptInfo p_info, bool p_isPdf = false, string p_title = null)

    /// <summary>
    /// 打开新窗口显示报表组
    /// </summary>
    /// <param name="p_infos">报表组描述信息</param>
    /// <param name="p_isPdf">报表是否采用Pdf格式</param>
    /// <param name="p_winTitle">窗口标题</param>
    /// <param name="p_icon">图标</param>
    public static void Show(IList<RptInfo> p_infos, bool p_isPdf = false, string p_winTitle = null, Icons p_icon = Icons.折线图)
}

RptDesignInfo

报表设计是报表系统的核心，报表设计的好坏直接影响到报表的使用效果，这部分在报表设计中已详细介绍。代码中很少需要直接调用报表设计器的情况，显示报表设计器的API：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

public static class Rpt
{
    /// <summary>
    /// 打开报表设计窗口
    /// </summary>
    /// <param name="p_info">报表设计描述信息，null时使用临时空模板</param>
    /// <param name="p_winTitle">窗口标题，null时使用报表名称</param>
    /// <param name="p_icon">窗口图标</param>
    /// <returns></returns>
    public static async Task<bool> ShowDesign(RptDesignInfo p_info, string p_winTitle = null, Icons p_icon = Icons.Excel)
}

RptDesignInfo可以控制报表设计的所有选项，如各种菜单项的显示控制、自定义保存模板的位置等。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

public partial class RptDesignInfo : RptInfoBase
{
    /// <summary>
    /// 是否显示新文件菜单项，默认false
    /// </summary>
    public bool ShowNewFile { get; set; }
        
    /// <summary>
    /// 是否显示打开文件菜单项，默认false
    /// </summary>
    public bool ShowOpenFile { get; set; }

    /// <summary>
    /// 是否显示保存菜单项，默认false
    /// </summary>
    public bool ShowSave { get; set; }
        
    /// <summary>
    /// 保存模板内容
    /// </summary>
    /// <param name="p_xml"></param>
    /// <returns></returns>
    public virtual async Task<bool> SaveTemplate(string p_xml)
}

报表控件

很多时候需要将报表预览功能和其它UI融入一体，这时需要使用报表控件RptTab。RptTab是一个包含报表预览功能的Tab控件，它的用法非常简单，只需在XAML中添加一个RptTab控件，在代码中调用LoadReport方法即可。

1
2
3
4

_rpt.LoadReport(new RptInfo { Uri = "rpt://综合" });
_rpt.LoadReport(new RptInfo { Uri = "local://rptdemo/综合" });
_rpt.LoadReport(new RptInfo { Uri = "ms-appx:///Demo.UI/Files/Content/zh.rpt" });
_rpt.LoadReport(new RptInfo { Uri = "embedded://Demo.UI/Demo.UI.Files.Embed.模板.综合.rpt" });

内部过程比较复杂： /dt-docs/6%E6%8A%A5%E8%A1%A8/3%E6%8A%A5%E8%A1%A8%E5%BA%94%E7%94%A8/4.png