提供事件、方法和物件，以與表單上的商務程序流程資料互動。 請參閱 formContext.ui.process （用戶端 API 參考） ， 以取得與表單上商務程序流程控制項互動的方法。
處理事件和事件處理常式方法
使用下列事件和事件處理常式方法來撰寫商務程序流程的腳本。
主動製程方法
使用這些方法來擷取作用中處理程序的相關資訊，並將不同的處理程序設定為作用中處理程序。
| 名稱 | Description |
|---|---|
| getActiveProcess | 傳回代表作用中進程的 Process 物件。 |
| setActiveProcess | 將 「程序 」設定為作用中程序。 |
工藝方法
程序包含商務程序流程的資料。 使用方法來存取程序的內容。
| 名稱 | Description |
|---|---|
| getId | 傳回進程的唯一識別碼。 |
| 取得名稱 | 傳回處理程序的名稱。 |
| getStages | 傳回程序中的階段集合。 |
| 是轉譯 | 傳回布林值，指出是否轉譯程序。 |
ProcessInstance 方法
使用這些方法來擷取記錄之所有程序實例的相關資訊，並將程序實例設為作用中實例。
| 名稱 | Description |
|---|---|
| getProcess實例 | 傳回呼叫使用者有權存取之表格記錄的所有處理程序實例。 |
| setActiveProcess實例 | 將程序實例設定為作用中實例。 |
實例方法
程序實例包含商務程序流程實例的資料。 使用方法來存取程序實例的內容。
| 名稱 | Description |
|---|---|
| getInstanceId | 傳回程序實例的唯一識別碼。 |
| get實例名稱 | 傳回程序實例的名稱。 |
| get狀態 | 傳回程序實例的目前狀態。 |
| 設定狀態 | 設定作用中程序實例的目前狀態。 |
主動階段方法
使用這些方法來擷取作用中階段的相關資訊，並將不同的階段設為作用中階段。
| 名稱 | Description |
|---|---|
| getActiveStage | 傳回代表作用中階段的 Stage 物件。 |
| setActive階段 | 將已完成的階段設定為作用中階段。 |
階段方法
階段包含商務程序流程中階段的資料。 使用這些方法來存取階段的內容。
| 名稱 | Description |
|---|---|
| get類別 | 傳回具有 getValue 方法的物件，該方法會傳回商務程序流程類別的整數值。 |
| getEntityName | 傳回與階段相關聯之資料表的邏輯名稱。 |
| getId | 傳回階段的唯一識別碼。 |
| 取得名稱 | 傳回階段的名稱。 |
| getNavigation行為 | 傳回階段的導覽行為物件，可用來定義使用者是否可以使用 [ 建立 ] 按鈕在跨資料表商務程序流程導覽案例中建立其他資料表記錄。 |
| get狀態 | 傳回階段的狀態。 |
| get步驟 | 傳回階段中的步驟集合。 |
步驟方法
步驟包含商務程序流程中階段中步驟的資料。 使用方法來存取步驟的內容。
| 名稱 | Description |
|---|---|
| get屬性 | 傳回與步驟相關聯之欄的邏輯名稱。 |
| 取得名稱 | 傳回步驟的名稱。 |
| 取得進度 | 傳回動作步驟的進度。 |
| 是必填 | 傳回布林值，指出商務程序流程中是否需要該步驟。 |
| 設定進度 | 更新動作步驟的進度。 |
導覽方法
使用這些方法移至下一個和上一個階段。 這兩種方法都會導致 OnStageChange 事件發生。
| 名稱 | Description |
|---|---|
| 移動下一頁 | 進入下一階段。 |
| 移動上一頁 | 移至上一階段。 |
其他有用的方法
使用這些方法來尋找作用中路徑中階段、已啟用程序及所選階段的相關資訊。
| 名稱 | Description |
|---|---|
| getActive路徑 | 取得目前作用中路徑中的階段集合，以及與商務程序流程控制項中顯示的階段互動的方法。 |
| getEnabled進程 | 以非同步方式擷取為目前使用者可以切換至的資料表啟用的商務程序流程。 |
| getSelected階段 | 取得目前選取的階段。 |
相關文章
formContext.ui.process （用戶端 API 參考）
了解 Xrm 物件模型
控制項 （用戶端 API 參考）