Skip to content

Commit d7335fd

Browse files
committed
Merge branch 'master' into 2145780
2 parents 9e40343 + f272fc1 commit d7335fd

File tree

69 files changed

+530
-331
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+530
-331
lines changed

powerapps-docs/developer/data-platform/configure-entity-relationship-cascading-behavior.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,9 @@ The `CascadeConfiguration` (<xref:Microsoft.Xrm.Sdk.Metadata.CascadeConfiguratio
5050
|UserOwned|Cascade User Owned|Perform the action on all referencing table records owned by the same user as the referenced table record.|
5151

5252
>[!NOTE]
53-
> Cascading actions on Active records will only include records that have a Status Code of Active. Any other solution provided or custom status
54-
> codes that indicate a record as live and in use will not be processed as an Active record for cascading purposes.
53+
> Cascading actions on active records will only include records that have a state code of "Active" and a status code of "Open".
54+
> If custom status and state code labels are being used, this is the same as `statecode` value=0 and `statuscode` value=1 in most cases.
55+
> Any other solution provided or custom status codes with values other than the above will not be processed as an active record for cascading purposes.
5556
5657

5758
The `CascadeConfiguration` (<xref:Microsoft.Xrm.Sdk.Metadata.CascadeConfiguration> class or <xref href="Microsoft.Dynamics.CRM.CascadeConfiguration?text=CascadeConfiguration ComplexType" />) contains the following properties representing actions that may be performed on the referenced table in the one-to-many relationship.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
href: supported-customizations.md
77
- name: Design app interface using code
88
items:
9-
- name: Customize entity forms
9+
- name: Customize forms
1010
href: customize-entity-forms.md
1111
items:
1212
- name: Use IFRAME and web resource controls on a form
1313
href: use-iframe-and-web-resource-controls-on-a-form.md
14-
- name: Customize entity views
14+
- name: Customize views
1515
href: customize-entity-views.md
1616
- name: Open forms, views, dialogs, and reports with a URL
1717
href: open-forms-views-dialogs-reports-url.md
1818
items:
19-
- name: Set field values using parameters passed to a form
19+
- name: Set column values using parameters passed to a form
2020
href: set-field-values-using-parameters-passed-form.md
2121
- name: Configure a form to accept custom querystring parameters
2222
href: configure-form-accept-custom-querystring-parameters.md
@@ -81,7 +81,7 @@
8181
- name: Client-side events
8282
href: clientapi/reference/events.md
8383
items:
84-
- name: Attribute OnChange event
84+
- name: Column OnChange event
8585
href: clientapi/reference/events/attribute-onchange.md
8686
- name: Form OnLoad event
8787
href: clientapi/reference/events/form-onload.md

powerapps-docs/developer/model-driven-apps/clientapi/clientapi-form-context.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Client API form context in model-driven apps| MicrosoftDocs"
3-
ms.date: 04/10/2019
3+
description: The Client API form context (**formContext**) provides a reference to the form or to an item on the form, such as, a quick view control or a row in an editable grid, against which the current code is executed.
4+
ms.date: 04/15/2021
45
ms.service: powerapps
56
ms.topic: "conceptual"
67
applies_to:
@@ -17,8 +18,6 @@ search.app:
1718
---
1819
# Client API form context
1920

20-
21-
2221
The Client API form context (**formContext**) provides a reference to the form or to an item on the form, such as, a quick view control or a row in an editable grid, against which the current code is executed.
2322

2423
Earlier, the global **Xrm.Page** object was used to represent a form or an item on the form. With the latest version, the **Xrm.Page** object is [deprecated](/dynamics365/get-started/whats-new/customer-engagement/important-changes-coming#some-client-apis-are-deprecated), and you should use the [getFormContext](reference/executioncontext/getFormContext.md) method of the passed in execution context object to return reference to the appropriate form or an item on the form.
@@ -62,19 +61,20 @@ Use the **data** and **ui** objects under the **formContext** object to programm
6261

6362
![formContext object model](../media/ClientAPI-formContextModel.png)
6463

65-
### data object
64+
[!INCLUDE[cc-terminology](../../data-platform/includes/cc-terminology.md)]
6665

66+
### data object
6767

68-
Provides properties and methods to work with the data on a form, including entity data and data in the business process flow control. Contains the following objects:
68+
Provides properties and methods to work with the data on a form, including table data and data in the business process flow control. Contains the following objects:
6969

7070

7171
| **Object** | **Description**|
7272
|--|--|
73-
|attributes|Collection of non-entity data on the form. Items in this collection are of the same type as the attributes collection, but they are not attributes of the form entity. <br/>More information: [Collections](collections.md)|
74-
|entity|Provides methods to retrieve information specific to the record displayed on the page, the save method, and a collection of all the attributes included on the form. Attribute data is limited to attributes represented by fields on the form. <br/>More information: [formContext.data.entity](formContext-data-entity.md)|
75-
|process|Provides objects and methods to interact with the business process flow data on a form.<br/>More information: [formContext.data.process](formContext-data-process.md)|
73+
|attributes|Collection of non-table data on the form. Items in this collection are of the same type as the column collection, but they are not columns of the form table. <br/>More information: [Collections](reference/collections.md)|
74+
|entity|Provides methods to retrieve information specific to the record displayed on the page, the save method, and a collection of all the columns included on the form. Column data is limited to columns represented on the form. <br/>More information: [formContext.data.entity](reference/formContext-data-entity.md)|
75+
|process|Provides objects and methods to interact with the business process flow data on a form.<br/>More information: [formContext.data.process](reference/formContext-data-process.md)|
7676

77-
It also provides an **attributes** collection for accessing non-entity bound control. See the **Collections in the formContext object model** section later in this topic.
77+
It also provides an **attributes** collection for accessing non-table bound control. See the **Collections in the formContext object model** section later in this topic.
7878

7979
More information: [formContext.data](reference/formContext-data.md)
8080

@@ -99,10 +99,10 @@ reference)](reference/collections.md).
9999

100100
| **Collection** | **Description**|
101101
|-----------------|----------------|
102-
| [attributes](reference/attributes.md) | Two objects contain an attributes collection:<br/><br/>- **formContext.data.attributes** collection provides access to non-entity bound attributes.<br/><br/>- **formContext.data.entity.attributes** collection provides access to each entity attribute that is available on the form. Only those attributes that correspond to fields added to the form are available.|
103-
| [controls](reference/controls.md) | Three objects contain a controls collection:<br/><br/> - **formContext.ui.controls**: Provides access to each control present on the form.<br/><br/>- **formContext.data.entity.attribute.controls**: Because an attribute may have more than one control on the form, this collection provides access to each of them. This collection will contain only one item unless multiple controls for the attribute are added to the form.<br/><br/>- **formContext.ui.tabs.sections.controls**: This collection only contains the controls found in the section.|
102+
| [attributes](reference/attributes.md) | Two objects contain a column collection:<br/><br/>- **formContext.data.attributes** collection provides access to non-table bound columns.<br/><br/>- **formContext.data.entity.attributes** collection provides access to each table column that is available on the form. Only those columns added to the form are available.|
103+
| [controls](reference/controls.md) | Three objects contain a controls collection:<br/><br/> - **formContext.ui.controls**: Provides access to each control present on the form.<br/><br/>- **formContext.data.entity.attribute.controls**: Because a column may have more than one control on the form, this collection provides access to each of them. This collection will contain only one item unless multiple controls for the column are added to the form.<br/><br/>- **formContext.ui.tabs.sections.controls**: This collection only contains the controls found in the section.|
104104
|**formContext.data.process.**[stages](reference/formContext-data-process/process/getStages.md) and **formContext.data.process**.[steps](reference/formContext-data-process/stage/getSteps.md)| Provides access to stages and steps collection in a business process flow. These also allow for adding and removing of items from the collection.|
105-
|**formContext.ui.formSelector.**[items](reference/formContext-ui-formselector.md)|When multiple forms are provided for an entity, you can associate each form with security roles. When the security roles associated with a user enable them to see more than one form, the **formContext.ui.formSelector.items** collection provides access to each form definition available to that user.|
105+
|**formContext.ui.formSelector.**[items](reference/formContext-ui-formselector.md)|When multiple forms are provided for a table, you can associate each form with security roles. When the security roles associated with a user enable them to see more than one form, the **formContext.ui.formSelector.items** collection provides access to each form definition available to that user.|
106106
|**formContext.ui.navigation.**[items](reference/formContext-ui-navigation.md)|The **formContext.ui.navigation.items** collection provides access to navigation items that are defined using the navigation area of the form editor. People navigate to these using the command bar.|
107107
| **formContext.ui.**[quickForms](reference/formContext-ui-quickForms.md) | Provides methods to access all the quick view controls and its constituent controls on the Customer Enagagement forms.| **Xrm.Page.ui.tabs** collection provides access to each of these tabs.|
108108
| **formContext.ui.**[tabs](reference/formContext-ui-tabs.md) | You can organize each form by using one or more tabs. This collection provides access to each of these tabs.|

powerapps-docs/developer/model-driven-apps/clientapi/events-forms-grids.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "Events in forms and grids in model-driven apps| MicrosoftDocs"
3-
ms.date: 01/13/2021
3+
description: All client-side code is initiated by events. In model-driven apps, you associate a specific function in a JavaScript library to be executed when an event occurs. This function is called an *event handler*.
4+
ms.date: 04/15/2021
45
ms.service: powerapps
56
ms.topic: "reference"
67
ms.assetid: 9fb38429-55ef-45ce-a3a3-e649e1be89d0
@@ -19,6 +20,8 @@ All client-side code is initiated by events. In model-driven apps, you associate
1920

2021
You can associate event handlers to only some events using the UI. For events that are not available to be associated through UI, Client API provides methods that can be used to attach event handlers to such events.
2122

23+
[!INCLUDE[cc-terminology](../../data-platform/includes/cc-terminology.md)]
24+
2225
## Add or remove event handler function to event using UI
2326

2427
### [Legacy](#tab/add-event-handlers-legacy)

powerapps-docs/developer/model-driven-apps/clientapi/reference/Xrm-Utility/getGlobalContext/organizationSettings.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,34 @@ Returns the ID of the current organization.
128128

129129
**Description**: Id of the current organization.
130130

131+
## isTrialOrganization
132+
133+
Returns a boolean indicating whether the organization is a trial organization.
134+
135+
### Syntax
136+
137+
`organizationSettings.isTrialOrganization`
138+
139+
### Return Value
140+
141+
**Type**: Boolean
142+
143+
**Description**: **true** if the organization is a trial organization; **false** otherwise.
144+
145+
## organizationExpiryDate
146+
147+
Returns the expiry date of the current organization if it is a trial organization.
148+
149+
### Syntax
150+
151+
`organizationSettings.organizationExpiryDate`
152+
153+
### Return Value
154+
155+
**Type**: Date
156+
157+
**Description**: Returns a `Date` object with the organization's expiry date if it is a trial organizaiton. Returns NULL if the organization is not a trial organization.
158+
131159
## uniqueName
132160

133161
Returns the unique name of the current organization.

powerapps-docs/developer/model-driven-apps/clientapi/reference/attributes.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: "Attributes in model-driven apps| MicrosoftDocs"
3-
description: "Learn about working with attributes in model-driven apps using client API."
2+
title: "Columns in model-driven apps| MicrosoftDocs"
3+
description: "Learn about working with columns in model-driven apps using client API."
44
ms.date: 10/31/2018
55
ms.service: powerapps
66
ms.topic: "reference"
@@ -15,19 +15,19 @@ search.app:
1515
- PowerApps
1616
- D365CE
1717
---
18-
# Attributes (Client API reference)
18+
# Columns (Client API reference)
1919

20+
Columns contain data in the model-driven apps form or grids. Use the `formContext.data.entity.attributes` collection or the `formContext.getAttribute` shortcut method to access a collection of columns. For more information about collections, see [Collections (Client API reference)](collections.md).
2021

22+
To access a column within the collection, you pass either the name (string) or the index value (number) of the column as an argument to the method. For example: `formContext.getAttribute(arg)`
2123

22-
Attributes contain data in the model-driven apps form or grids. Use the `formContext.data.entity.attributes` collection or the `formContext.getAttribute` shortcut method to access a collection of attributes. For more information about collections, see [Collections (Client API reference)](collections.md).
24+
Columns are categorized by type. You can determine the type of the column by using the [getAttributeType](attributes/getAttributeType.md) method. Certain column methods are only available for specific types of columns.
2325

24-
To access an attribute within the collection, you pass either the name (string) or the index value (number) of the attribute as an argument to the method. For example: `formContext.getAttribute(arg)`
26+
[!INCLUDE[cc-terminology](../../../data-platform/includes/cc-terminology.md)]
2527

26-
Attributes are categorized by type. You can determine the type of an attribute by using the [getAttributeType](attributes/getAttributeType.md) method. Certain attribute methods are only available for specific types of attributes.
28+
This topic provides information about the methods available per column type.
2729

28-
This topic provides information about the methods available per attribute type.
29-
30-
## All attribute types
30+
## All column types
3131

3232
<table>
3333
<tr>
@@ -66,20 +66,20 @@ This topic provides information about the methods available per attribute type.
6666
</table>
6767

6868

69-
## Boolean attribute type
69+
## Boolean column type
7070

71-
In addition to the methods available for all attribute types as explained earlier, the following method is available only for the **boolean** attribute:
71+
In addition to the methods available for all column types as explained earlier, the following method is available only for the **boolean** column:
7272

7373
- [getInitialValue](attributes/getInitialValue.md)
7474

75-
## Lookup attribute type
76-
In addition to the methods available for all attribute types as explained earlier, the following method is available only for the **lookup** attribute:
75+
## Lookup column type
76+
In addition to the methods available for all column types as explained earlier, the following method is available only for the **lookup** column:
7777

7878
- [getIsPartyList](attributes/getIsPartyList.md)
7979

80-
## MultiSelectOptionSet and OptionSet attribute types
80+
## Choices and choice column types
8181

82-
In addition to the methods available for all attribute types as explained earlier, the following methods are available only for the **multiselectoption** and **optionset** attributes:
82+
In addition to the methods available for all column types as explained earlier, the following methods are available only for the **choices** and **choice** columns:
8383

8484
<table>
8585
<tr>
@@ -95,8 +95,9 @@ In addition to the methods available for all attribute types as explained earlie
9595
</tr>
9696
</table>
9797

98-
## Number attribute type (decimal, double, integer, money)
99-
The following methods are available only for the **decimal**, **double**, and **integer** attributes:
98+
## Number column type (decimal, double, integer, money)
99+
100+
The following methods are available only for the **decimal**, **double**, and **integer** columns:
100101

101102
<table>
102103
<tr>
@@ -111,18 +112,16 @@ The following methods are available only for the **decimal**, **double**, and *
111112
</tr>
112113
</table>
113114

114-
## String attribute type
115-
In addition to the methods available for all attribute types as explained earlier, the following method is available only for the **string** attribute:
115+
## String column type
116+
In addition to the methods available for all column types as explained earlier, the following method is available only for the **string** column:
116117

117118
- [getMaxLength](attributes/getMaxLength.md)
118119

119120

120121
### Related topics
121122

122-
[Composite attributes](composite-attributes.md)
123-
124-
[Understand Xrm object model](../understand-clientapi-object-model.md)
125-
123+
[Composite columns](composite-attributes.md)<br/>
124+
[Understand Xrm object model](../understand-clientapi-object-model.md)<br/>
126125
[Controls (Client API reference)](controls.md)
127126

128127

powerapps-docs/developer/model-driven-apps/clientapi/reference/attributes/getIsPartyList.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "getIsPartyList (Client API reference)| MicrosoftDocs"
3-
ms.date: 10/31/2018
3+
description: Returns a boolean value indicating whether the lookup represents a partylist lookup.
4+
ms.date: 04/15/2021
45
ms.service: powerapps
56
ms.topic: "reference"
67
applies_to: "Dynamics 365 (online)"
@@ -16,23 +17,23 @@ search.app:
1617
---
1718
# getIsPartyList (Client API reference)
1819

20+
Returns a Boolean value indicating whether the lookup represents a partylist lookup. Partylist lookups allow for multiple records to be set, such as the **To:** column for an email table record.
1921

20-
21-
Returns a Boolean value indicating whether the lookup represents a partylist lookup. Partylist lookups allow for multiple records to be set, such as the **To:** field for an email entity record.
22-
23-
## Attribute types supported
22+
## Column types supported
2423

2524
Lookup
2625

2726
## Syntax
2827

2928
`formContext.getAttribute(arg).getIsPartyList()`
3029

30+
[!INCLUDE[cc-terminology](../../../../data-platform/includes/cc-terminology.md)]
31+
3132
## Return Value
3233

3334
**Type**: Boolean.
3435

35-
**Description**: True if the lookup attribute is a partylist, otherwise false.
36+
**Description**: True if the lookup column is a partylist, otherwise false.
3637

3738

3839

powerapps-docs/developer/model-driven-apps/clientapi/reference/attributes/getParent.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: "getParent (Client API reference)| MicrosoftDocs"
3-
ms.date: 10/31/2018
3+
description: Returns the formContext.data.entity object that is the parent to all the columns.
4+
ms.date: 04/15/2021
45
ms.service: powerapps
56
ms.topic: "reference"
67
applies_to: "Dynamics 365 (online)"
@@ -16,18 +17,18 @@ search.app:
1617
---
1718
# getParent (Client API reference)
1819

20+
Returns the `formContext.data.entity` object that is the parent to all the columns.
1921

20-
21-
Returns the `formContext.data.entity` object that is the parent to all attributes.
22-
23-
## Attribute types supported
22+
## Column types supported
2423

2524
All
2625

2726
## Syntax
2827

2928
`formContext.getAttribute(arg).getParent()`
3029

30+
[!INCLUDE[cc-terminology](../../../../data-platform/includes/cc-terminology.md)]
31+
3132
## Return Value
3233

3334
**Type**: `formContext.data.entity` object.

0 commit comments

Comments
 (0)