ListViewController
类名:ListViewController
说明:列表控制器,用于控制列表的提交和展示,继承 H3.SmartForm.SmartController 类。
构造函数
功能
初始化列表控制器实例,接收列表请求上下文,为列表操作提供基础环境(如请求数据加载、核心服务初始化)。
接口定义
public ListViewController(ListViewRequest request);
参数说明
| 参数名称 | 是否必填 | 类型 | 描述 |
|---|---|---|---|
request |
是 | ListViewRequest |
列表请求上下文,包含列表配置(ListViewSetting)、用户信息(UserContext)、业务对象结构(Schema)、筛选条件等核心数据,是后续所有列表操作的基础输入。 |
Engine 属性(保护只读)
功能
提供当前请求的引擎实例,子类可通过该属性调用系统服务(如组织结构、业务对象管理、日志记录等)。
接口定义
protected IEngine Engine { get; }
返回值
| 类型 | 描述 |
|---|---|
IEngine |
当前请求上下文关联的引擎实例,包含系统核心服务的访问入口。 |
Request 属性
功能
提供当前列表请求的完整上下文,是子类获取请求数据(如用户信息、列表配置)的核心入口。
接口定义
protected ListViewRequest Request { get; }
返回值说明
| 类型 | 核心包含字段 | 描述 |
|---|---|---|
H3.SmartForm.ListViewRequest |
ListViewSetting |
列表配置: • 含列定义 • 工具栏按钮 • 默认排序规则 |
UserContext |
用户上下文: • 含用户 ID • 角色 • 权限等信息 |
|
Schema |
业务对象结构: • 含主表/子表字段定义 • 数据类型等 |
|
Filter |
筛选条件: • 存储用户输入的查询条件(如时间范围、字段匹配) |
OnInit 方法
功能
列表配置初始化的扩展入口,允许子类自定义列表配置(如添加自定义列、隐藏默认列、调整工具栏按钮权限)。
接口定义
protected virtual void OnInit(LoadListViewResponse response);
参数说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
response |
H3.SmartForm.LoadListViewResponse |
列表配置响应对象,子类可通过修改该对象调整配置(如 Columns 列集合、Actions 按钮集合)。 |
OnLoad 方法
功能
列表数据加载的扩展入口,允许子类调整筛选条件、处理数据格式、补充额外数据(如关联其他业务对象信息)。
接口定义
protected virtual void OnLoad(LoadListViewResponse response);
参数说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
response |
LoadListViewResponse |
列表数据响应对象,子类可修改筛选条件(Request.Filter)、处理返回数据(response.ReturnData)。 |
OnSubmit 方法
功能
提交类操作的扩展入口,允许子类添加自定义业务操作(如批量审批、数据同步),或修改默认操作逻辑(如删除前增加业务校验)。
接口定义
protected virtual void OnSubmit(string actionName,
ListViewPostValue postValue,
SubmitListViewResponse response);
参数说明
| 参数名称 | 类型 | 描述 |
|---|---|---|
actionName |
string |
提交动作名称(如自定义的 BatchApprove 批量审批)。 |
postValue |
ListViewPostValue |
提交数据,含待操作的记录 ID(ObjectIds)、自定义参数等。 |
response |
SubmitListViewResponse |
提交响应对象,用于存储操作结果(成功信息、错误提示)与刷新标识。 |