Skip to content

Commit 79e0feb

Browse files
committed
Add OnPreProcessStatusChange event docs
1 parent 1dd29bd commit 79e0feb

File tree

7 files changed

+103
-0
lines changed

7 files changed

+103
-0
lines changed

powerapps-docs/developer/model-driven-apps/clientapi/TOC.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
href: ./reference/events/grid-onsave.md
2424
- name: OnProcessStatusChange event
2525
href: ./reference/events/onprocessstatuschange.md
26+
- name: OnPreProcessStatusChange event
27+
href: ./reference/events/onpreprocessstatuschange.md
2628
- name: OnReadyStateComplete event
2729
href: ./reference/events/onreadystatecomplete.md
2830
- name: OnResultOpened event
@@ -279,12 +281,16 @@
279281
items:
280282
- name: Event handler methods
281283
items:
284+
- name: addOnPreProcessStatusChange
285+
href: reference/formContext-data-process/eventhandlers/addOnPreProcessStatusChange.md
282286
- name: addOnProcessStatusChange
283287
href: reference/formContext-data-process/eventhandlers/addOnProcessStatusChange.md
284288
- name: addOnStageChange
285289
href: reference/formContext-data-process/eventhandlers/addOnStageChange.md
286290
- name: addOnStageSelected
287291
href: reference/formContext-data-process/eventhandlers/addOnStageSelected.md
292+
- name: removeOnPreProcessStatusChange
293+
href: reference/formContext-data-process/eventhandlers/removeOnPreProcessStatusChange.md
288294
- name: removeOnProcessStatusChange
289295
href: reference/formContext-data-process/eventhandlers/removeOnProcessStatusChange.md
290296
- name: removeOnStageChange
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "OnPreProcessStatusChange Event (Client API reference) in Dynamics 365 for Customer Engagement| MicrosoftDocs"
3+
ms.date: 10/31/2017
4+
ms.service: crm-online
5+
ms.topic: reference
6+
applies_to: Dynamics 365 for Customer Engagement (online)
7+
ms.assetid:
8+
author: MSFTMan
9+
ms.author: Deonhe
10+
manager: KVivek
11+
search.audienceType:
12+
- developer
13+
search.app:
14+
- D365CE
15+
---
16+
# OnPreProcessStatusChange Event (Client API reference)
17+
18+
[!INCLUDE[](../../../../includes/cc_applies_to_update_9_0_0.md)]
19+
20+
This event occurs **before** the status of a process instance changes.
21+
22+
Use the **formContext.data.process**.[addOnPreProcessStatusChange](../formContext-data-process/eventhandlers/addOnPreProcessStatusChange.md) method to add event handlers for this event and the **formContext.data.process**.[removeOnPreProcessStatusChange](../formContext-data-process/eventhandlers/removeOnPreProcessStatusChange.md) method to remove them.

powerapps-docs/developer/model-driven-apps/clientapi/reference/formContext-data-process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Use the following events and event handler methods to write scripts for business
2727

2828
|Event | Event handler methods|
2929
|--|--|
30+
|[OnPreProcessStatusChange](events/onpreprocessstatuschange.md)|[addOnPreProcessStatusChange](formContext-data-process/eventhandlers/addOnPreProcessStatusChange.md)<br/>[removeOnPreProcessStatusChange](formContext-data-process/eventhandlers/removeOnPreProcessStatusChange.md)|
3031
|[OnProcessStatusChange](events/onprocessstatuschange.md)|[addOnProcessStatusChange](formContext-data-process/eventhandlers/addOnProcessStatusChange.md)<br/>[removeOnProcessStatusChange](formContext-data-process/eventhandlers/removeOnProcessStatusChange.md)|
3132
|[OnStageChange](events/OnStageChange.md)|[addOnStageChange](formContext-data-process/eventhandlers/addOnStageChange.md)<br/>[removeOnStageChange](formContext-data-process/eventhandlers/removeOnStageChange.md)|
3233
|[OnStageSelected](events/OnStageSelected.md)|[addOnStageSelected](formContext-data-process/eventhandlers/addOnStageSelected.md)<br/>[removeOnStageSelected](formContext-data-process/eventhandlers/removeOnStageSelected.md)|
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "addOnPreProcessStatusChange (Client API reference) in Dynamics 365 for Customer Engagement| MicrosoftDocs"
3+
ms.date: 11/20/2017
4+
ms.service: crm-online
5+
ms.topic: reference
6+
applies_to: Dynamics 365 for Customer Engagement (online)
7+
ms.assetid:
8+
author: KumarVivek
9+
ms.author: kvivek
10+
manager: amyla
11+
search.audienceType:
12+
- developer
13+
search.app:
14+
- D365CE
15+
---
16+
# addOnPreProcessStatusChange (Client API reference)
17+
18+
[!INCLUDE[](../../../../../includes/cc_applies_to_update_9_0_0.md)]
19+
20+
[!INCLUDE[./includes/addOnPreProcessStatusChange-description.md](./includes/addOnPreProcessStatusChange-description.md)]
21+
22+
## Syntax
23+
24+
`formContext.data.process.addOnPreProcessStatusChange(myFunction);`
25+
26+
## Parameter
27+
28+
|Name|Type|Required|Description|
29+
|--|--|--|--|
30+
|myFunction|Function reference|Yes|The function to be executed when the business process flow status changes. The function will be added to the bottom of the event handler pipeline. The execution context is automatically passed as the first parameter to the function. See [Execution context](../../../clientapi-execution-context.md) for more information.<br/><br/>You should use a reference to a named function rather than an anonymous function if you may later want to remove the event handler.|
31+
32+
### Related topics
33+
34+
[removeOnProcessStatusChange](removeOnProcessStatusChange.md)
35+
36+
[formContext.data.process](../../formContext-data-process.md)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Removes an event handler from the [OnPreProcessStatusChange](../../../events/onpreprocessstatuschange.md) event.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Adds a function as an event handler for the [OnPreProcessStatusChange](../../../events/onpreprocessstatuschange.md) event so that it will be called **before** the business process flow status changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "removeOnPreProcessStatusChange (Client API reference) in Dynamics 365 for Customer Engagement| MicrosoftDocs"
3+
ms.date: 06/20/2019
4+
ms.service: crm-online
5+
ms.topic: reference
6+
applies_to: Dynamics 365 for Customer Engagement (online)
7+
ms.assetid:
8+
author: MSFTMan
9+
ms.author: Deonhe
10+
manager: KVivek
11+
search.audienceType:
12+
- developer
13+
search.app:
14+
- D365CE
15+
---
16+
# removeOnPreProcessStatusChange (Client API reference)
17+
18+
[!INCLUDE[](../../../../../includes/cc_applies_to_update_9_0_0.md)]
19+
20+
[!INCLUDE[./includes/removeOnPreProcessStatusChange-description.md](./includes/removeOnPreProcessStatusChange-description.md)]
21+
22+
## Syntax
23+
24+
`formContext.data.process.removeOnPreProcessStatusChange(myFunction);`
25+
26+
## Parameter
27+
28+
|Name|Type|Required|Description|
29+
|--|--|--|--|
30+
|myFunction|Function reference|Yes|The function to be removed from the [OnPreProcessStatusChange](../../events/onpreprocessstatuschange.md) event.|
31+
32+
### Related topics
33+
34+
[addOnProcessStatusChange](addOnProcessStatusChange.md)
35+
36+
[formContext.data.process](../../formContext-data-process.md)

0 commit comments

Comments
 (0)