提供事件、方法和对象，以便与表单上的业务流程数据进行交互。 有关与表单上的业务流程控件交互的方法，请参阅 formContext.ui.process （客户端 API 参考 ）。
处理事件和事件处理程序方法
使用以下事件和事件处理程序方法为业务流程编写脚本。
活动进程方法
使用这些方法检索有关活动进程的信息，并将其他进程设置为活动进程。
| Name | Description |
|---|---|
| getActiveProcess | 返回表示活动进程的 Process 对象。 |
| setActiveProcess | 将 进程 设置为活动进程。 |
处理方法
进程包含业务流程的数据。 使用方法访问进程的属性。
| Name | Description |
|---|---|
| getId | 返回进程的唯一标识符。 |
| getName | 返回进程的名称。 |
| getStages | 返回进程中阶段的集合。 |
| isRendered | 返回一个布尔值，该值指示是否呈现进程。 |
ProcessInstance 方法
使用这些方法检索记录的所有进程实例的相关信息，并将进程实例设置为活动实例。
| Name | Description |
|---|---|
| getProcessInstances | 返回调用用户有权访问的表记录的所有进程实例。 |
| setActiveProcessInstance | 将进程实例设置为活动实例。 |
实例方法
进程实例包含业务流程实例的数据。 使用方法访问进程实例的属性。
| Name | Description |
|---|---|
| getInstanceId | 返回进程实例的唯一标识符。 |
| getInstanceName | 返回进程实例的名称。 |
| getStatus | 返回进程实例的当前状态。 |
| setStatus | 设置活动进程实例的当前状态。 |
活动阶段方法
使用这些方法来检索有关活动阶段的信息，并将不同的阶段设置为活动阶段。
| Name | Description |
|---|---|
| getActiveStage | 返回表示活动阶段的 Stage 对象。 |
| setActiveStage | 将已完成阶段设置为活动阶段。 |
阶段方法
阶段包含业务流程中某个阶段的数据。 使用方法访问阶段的属性。
| Name | Description |
|---|---|
| getCategory | 返回一个具有 getValue 方法的对象，该方法将返回业务流程类别的整数值。 |
| getEntityName | 返回与阶段关联的表的逻辑名称。 |
| getId | 返回阶段的唯一标识符。 |
| getName | 返回阶段的名称。 |
| getNavigationBehavior | 返回可用于定义“ 创建 ”按钮是否可供用户在跨表业务流程导航方案中创建其他表记录的阶段的导航行为对象。 |
| getStatus | 返回阶段的状态。 |
| getSteps | 返回阶段中的步骤集合。 |
步骤方法
步骤包含业务流程中某个阶段的步骤的数据。 使用方法访问步骤的属性。
| Name | Description |
|---|---|
| getAttribute | 返回与步骤关联的列的逻辑名称。 |
| getName | 返回步骤的名称。 |
| getProgress | 返回作步骤的进度。 |
| isRequired | 返回一个布尔值，该值指示是否需要在业务流程中执行该步骤。 |
| setProgress | 更新作步骤的进度。 |
导航方法
使用这些方法移动到下一阶段和以前的阶段。 这两种方法都将导致 OnStageChange 事件发生。
| Name | Description |
|---|---|
| moveNext | 进入下一阶段。 |
| movePrevious | 移动到上一阶段。 |
其他有用的方法
使用这些方法查找有关活动路径、已启用的进程和所选阶段中的阶段的信息。
| Name | Description |
|---|---|
| getActivePath | 获取当前活动路径中的阶段的集合，其中包含与业务流程控制中显示的阶段进行交互的方法。 |
| getEnabledProcesses | 异步检索为当前用户可以切换到的表启用的业务流程。 |
| getSelectedStage | 获取当前选定的阶段。 |
相关文章
formContext.ui.process （客户端 API 参考）
了解 Xrm 对象模型
控件（客户端 API 参考）