You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> This method is supported only on Unified Interface.
24
22
@@ -28,138 +26,99 @@ search.app:
28
26
29
27
## Parameters
30
28
31
-
<tablestyle="width:100%">
32
-
<tr>
33
-
<th>Name</th>
34
-
<th>Type</th>
35
-
<th>Required</th>
36
-
<th>Description</th>
37
-
</tr>
38
-
<tr>
39
-
<td>pageInput</td>
40
-
<td>Object</td>
41
-
<td>Yes</td>
42
-
<td><p>Input about the page to navigate to. The object definition changes depending on the type of page to navigate to: <i>entity list</i>, <i>entity record</i>, <i> dashboard</i>, or <i>HTML web resource</i>.</p>
<li><strong>entityName</strong>: String. The logical name of the table to load in the list control.</li>
49
-
<li><strong>viewId</strong>: (Optional) String. The ID of the view to load. If you don't specify it, navigates to the default main view for the table.</li>
50
-
<li><strong>viewType</strong>: (Optional) String. Type of view to load. Specify "savedquery" or "userquery".</li>
<li><b>entityName</b>: String. Logical name of the table to display the form for.</li>
58
-
<li><b>entityId</b>: (Optional) String. ID of the table record to display the form for. If you don't specify this value, the form will be opened in create mode.</li>
59
-
<li><b>createFromEntity</b>: (Optional) Lookup. Designates a record that will provide default values based on mapped column values. The lookup object has the following String properties: <code>entityType</code>, <code>id</code>, and <code>name</code> (optional).</li>
60
-
<li><b>data</b>: (Optional) Object. A dictionary object that passes extra parameters to the form. Invalid parameters will cause an error.<br/>For information about passing parameters to a form, see <a href="/powerapps/developer/model-driven-apps/set-field-values-using-parameters-passed-form
61
-
">Set column values using parameters passed to a form</a> and <ahref="/powerapps/developer/model-driven-apps/configure-form-accept-custom-querystring-parameters">Configure a form to accept custom querystring parameters</a>.</li>
62
-
<li><b>formId</b>: (Optional) String. ID of the form instance to be displayed.</li>
63
-
<li><b>isCrossEntityNavigate</b>: (Optional) Boolean. Indicates whether the form is navigated to from a different table using cross-table business process flow.</li>
64
-
<li><b>isOfflineSyncError</b>: (Optional) Boolean. Indicates whether there are any offline sync errors.</li>
65
-
<li><b>processId</b>: (Optional) String. ID of the business process to be displayed on the form.</li>
66
-
<li><b>processInstanceId</b>: (Optional) String. ID of the business process instance to be displayed on the form.</li>
67
-
<li><b>relationship</b>: (Optional) Object. Define a relationship object to display the related records on the form. The object has the following values.
68
-
<tablestyle="width:100%">
69
-
<tr>
70
-
<th>Name</th>
71
-
<th>Type</th>
72
-
<th>Description</th>
73
-
<tr>
74
-
<td>attributeName</td>
75
-
<td>String</td>
76
-
<td>Name of the column used for relationship.</td>
77
-
</tr>
78
-
<tr>
79
-
<td>name</td>
80
-
<td>String</td>
81
-
<td>Name of the relationship.</td>
82
-
</tr>
83
-
<tr>
84
-
<td>navigationPropertyName</td>
85
-
<td>String</td>
86
-
<td>Name of the navigation property for this relationship.</td>
87
-
</tr>
88
-
<tr>
89
-
<td>relationshipType</td>
90
-
<td>Number</td>
91
-
<td>Relationship type. Specify one of the following values:
<li><strong>name</strong>: String. The logical name of the custom page to open.</li>
112
-
<li><strong>entityName</strong>: (Optional) String. The logical name of the table to be made available in the custom page via Param("entityName").</li>
113
-
<li><strong>recordId</strong>: (Optional) String. ID of the table record to be made available in the custom page via Param("recordId").</li>
<li><strong>dashboardId</strong>: String. The ID of the dashboard to load. If you don't specify the ID, navigates to the default dashboard.</li>
130
-
</ul>
131
-
</td>
132
-
</tr>
133
-
<tr>
134
-
<td>navigationOptions</td>
135
-
<td>Object</td>
136
-
<td>No</td>
137
-
<td><p>Options for navigating to a page: whether to open inline or in a dialog. If you don't specify this parameter, page is opened inline by default. The object contains the following values:</p>
138
-
<ul>
139
-
<li><strong>target</strong>: Number. Specify <strong>1</strong> to open the page inline; <strong>2</strong> to open the page in a dialog. Also, rest of the values (<b>width</b>, <b>height</b>, and <b>position</b>) are valid only if you have specified <strong>2</strong> in this value (open page in a dialog). <p><b>NOTE</b>: <i>Entity lists</i> can only be opened inline; <i>entity records</i> and <i>web resources</i> can be opened either inline or in a dialog.</p></li>
140
-
<li><strong>width</strong>: (Optional) Number or Object. The width of dialog. To specify the width in pixels, just type a numeric value. To specify the width in percentage, specify an object of type <b>SizeValue</b> with the following properties:
141
-
<ul><li><b>value</b>: Number. The numerical value.</li>
142
-
<li><b>unit</b>: String. The unit of measurement. Specify "%" or "px". Default value is "px".</li></ul></li>
143
-
<li><strong>height</strong>: (Optional) Number or Object. The height of dialog. To specify the height in pixels, just type a numeric value. To specify the width in percentage, specify an object of type <b>SizeValue</b> with the following properties:
144
-
<ul><li><b>value</b>: Number. The numerical value.</li>
145
-
<li><b>unit</b>: String. The unit of measurement. Specify "%" or "px". Default value is "px".</li></ul></li>
146
-
<li><strong>position</strong>: (Optional) Number. Specify <strong>1</strong> to open the dialog in center; <strong>2</strong> to open the dialog on the side. Default is 1 (center).</li>
147
-
<li><strong>title</strong>: (Optional) String. The dialog title on top of the center or side dialog.</li>
148
-
</ul></td>
149
-
</tr>
150
-
<tr>
151
-
<td>successCallback</td>
152
-
<td>function</td>
153
-
<td>No</td>
154
-
<td><p>A function to execute on successful navigation to the page when navigating inline and on closing the dialog when navigating to a dialog.</p></td>
155
-
</tr>
156
-
<tr>
157
-
<td>errorCallback</td>
158
-
<td>Function</td>
159
-
<td>No</td>
160
-
<td><p>A function to execute when the operation fails.</p></td>
161
-
</tr>
162
-
</table>
29
+
| Name | Type | Required | Description |
30
+
| --- | --- | --- | --- |
31
+
|[pageInput](#pageinput-parameter)| Object | Yes | Input about the page to navigate to. The object definition changes depending on the type of page to navigate to: [entity list](#entity-list), [entity record](#entity-record), [dashboard](#dashboard), [HTML web resource](#html-web-resource), or [custom page](#custom-page). |
32
+
|[navigationOptions](#navigationoptions-parameter)| Object | No | Options for navigating to a page: whether to open inline or in a dialog. If you don't specify this parameter, page is opened inline by default. |
33
+
| successCallback | function | No | A function to execute on successful navigation to the page when navigating inline and on closing the dialog when navigating to a dialog. |
34
+
| errorCallback | Function | No | A function to execute when the operation fails. |
35
+
36
+
### pageInput parameter
37
+
38
+
#### Entity list
39
+
40
+
The entity list object contains the following values.
41
+
42
+
| Name | Type | Description |
43
+
| --- | --- | --- |
44
+
| pageType | String | Specify "entitylist". |
45
+
| entityName | String | The logical name of the table to load in the list control. |
46
+
| viewId | String | (Optional) The ID of the view to load. If you don't specify it, navigates to the default main view for the table. |
47
+
| viewType | String | (Optional) Type of view to load. Specify "savedquery" or "userquery". |
48
+
49
+
#### Entity record
50
+
51
+
The entity record object contains the following values.
52
+
53
+
| Name | Type | Description |
54
+
| --- | --- | --- |
55
+
| pageType | String | Specify "entityrecord". |
56
+
| entityName | String | Logical name of the table to display the form for. |
57
+
| entityId | String | (Optional) ID of the table record to display the form for. If you don't specify this value, the form will be opened in create mode. |
58
+
| createFromEntity | Lookup | (Optional) Designates a record that will provide default values based on mapped column values. The lookup object has the following String properties: entityType, id, and name (optional). |
59
+
| data | Object | (Optional) A dictionary object that passes extra parameters to the form. Invalid parameters will cause an error. <p/>For information about passing parameters to a form, see [Set column values using parameters passed to a form](/powerapps/developer/model-driven-apps/set-field-values-using-parameters-passed-form.md) and [Configure a form to accept custom querystring parameters](/powerapps/developer/model-driven-apps/configure-form-accept-custom-querystring-parameters.md). |
60
+
| formId | String | (Optional) ID of the form instance to be displayed. |
61
+
| isCrossEntityNavigate | Boolean | (Optional) Indicates whether the form is navigated to from a different table using cross-table business process flow. |
62
+
| isOfflineSyncError | Boolean | (Optional) Indicates whether there are any offline sync errors. |
63
+
| processId | String | (Optional) ID of the business process to be displayed on the form. |
64
+
| processInstanceId | String | (Optional) ID of the business process instance to be displayed on the form. |
65
+
|[relationship](#relationship-object)| Object | (Optional) Define a relationship object to display the related records on the form. |
66
+
| selectedStageId | String | (Optional) ID of the selected stage in business process instance. |
67
+
| tabName | String | (Optional) Sets the focus on the tab of the form. |
68
+
69
+
##### Relationship object
70
+
71
+
The relationship object, used in the [Entity record](#entity-record), contains the following values.
72
+
73
+
| Name | Type | Description |
74
+
| --- | --- | --- |
75
+
| attributeName | String | Name of the column used for relationship. |
76
+
| name | String | Name of the relationship. |
77
+
| navigationPropertyName | String | Name of the navigation property for this relationship. |
78
+
| relationshipType | Number | Relationship type. Specify one of the following values: *0*:OneToMany, *1*:ManyToMany. |
79
+
| roleType | Number | Role type in relationship. Specify one of the following values: *1*:Referencing, *2*:AssociationEntity. |
80
+
81
+
#### Dashboard
82
+
83
+
The dashboard object contains the following values.
84
+
85
+
| Name | Type | Description |
86
+
| --- | --- | --- |
87
+
| pageType | String | Specify "dashboard". |
88
+
| dashboardId | String | The ID of the dashboard to load. If you don't specify the ID, navigates to the default dashboard. |
89
+
90
+
#### HTML web resource
91
+
92
+
The HTML web resource object contains the following values.
93
+
94
+
| Name | Type | Description |
95
+
| --- | --- | --- |
96
+
| pageType | String | Specify "webresource". |
97
+
| webresourceName | String | The name of the web resource to load. |
98
+
| data | String | (Optional) The data to pass to the web resource. |
99
+
100
+
#### Custom page
101
+
102
+
The Custom page object contains the following values.
103
+
104
+
| Name | Type | Description |
105
+
| --- | --- | --- |
106
+
| pageType | String | Specify "custom". |
107
+
| name | String | The logical name of the custom page to open. |
108
+
| entityName | String | (Optional) The logical name of the table to be made available in the custom page via Param("entityName"). |
109
+
| recordId | String | (Optional) ID of the table record to be made available in the custom page via Param("recordId"). |
110
+
111
+
### navigationOptions parameter
112
+
113
+
The navigationOptions object contains the following values.
114
+
115
+
| Name | Type | Description |
116
+
| --- | --- | --- |
117
+
| target | Number | Specify 1 to open the page inline; 2 to open the page in a dialog. Also, rest of the values (width, height, and position) are valid only if you have specified 2 in this value (open page in a dialog).<p/>Note: Entity lists can only be opened inline; entity records and web resources can be opened either inline or in a dialog. |
118
+
| width | Number or Object | (Optional) The width of dialog. To specify the width in pixels, just type a numeric value. To specify the width in percentage, specify an object of type SizeValue with the following properties:<ul><li>value: The numerical value of type Number.<li>unit: The unit of measurement of type String. Specify "%" or "px". Default value is "px".</ul> |
119
+
| height | Number or Object | (Optional) The height of dialog. To specify the height in pixels, just type a numeric value. To specify the width in percentage, specify an object of type SizeValue with the following properties:<ul><li>value: The numerical value of type Number.<li>unit: The unit of measurement of type String. Specify "%" or "px". Default value is "px".</ul> |
120
+
| position | Number | (Optional) Specify 1 to open the dialog in center; 2 to open the dialog on the far side. Default is 1 (center). |
121
+
| title | String | (Optional) The dialog title on top of the center or side dialog. |
0 commit comments