Pagelink module
Important
The finance and operations (Dynamics 365) mobile app and platform have been deprecated. For more information, see Removed or deprecated platform features.
A pagelink is a control that navigates to another page.
Index
Types
Types
PageLink
Hierarchy
Control
└─ PageLink
Properties
| Name | Signature | Description |
|---|---|---|
| container | container: boolean (optional) |
True if the control is a container. Inherited from Control.container |
| generic | generic: boolean (optional) |
Inherited from Control.generic |
| getDataSource | getDataSource: function(): any |
Inherited from Control.getDataSource |
| hidden | hidden: boolean |
True if the control is hidden. Inherited from Control.hidden |
Methods
| Name | Signature | Description |
|---|---|---|
| allowsNavigation | allowsNavigation(): boolean | |
| applyDesign | applyDesign(design: PageLinkDesign): void | Applies given design to the design on the control. Overrides Control.applyDesign |
| dataContext | dataContext(): any | Inherited from Control.dataContext |
| getCount | getCount(): number | string | |
| getDesign | getDesign(): Design | Returns the design object of this control. Inherited from Control.getDesign |
| getNavigationHandler | getNavigationHandler(): NavigationArgs | |
| isEditable | isEditable(): boolean | Boolean indicating if the control is editable. Inherited from Control.isEditable |
| metadata | metadata(): PageLinkMetadata | Returns the metadata object of this control. Overrides Control.metadata |
| parent | parent(): Control | Page | Returns the parent (control or page) of this control. Inherited from Control.parent |
| root | root(): Page | Returns the root form instance (page) of this control. Inherited from Control.root |
| showCount | showCount(): boolean |
PageLinkDesign
Hierarchy
Design
└─ PageLinkDesign
Properties
| Name | Signature | Description |
|---|---|---|
| alignItems | alignItems: string (optional) |
This property is an alias for the CSS property "align-items". Inherited from Design.alignItems |
| alignSelf | alignSelf: string (optional) |
Inherited from Design.alignSelf |
| background | background: string (optional) |
Sets the background color. |
| bindings | bindings: any (optional) |
Inherited from Design.bindings |
| border | border: "none" | "solid" | "left" | "right" | "top" | "bottom" (optional) |
The border behavior of a control. This property will not be inherited by the children. Inherited from Design.border |
| color | color: string (optional) |
The foreground color of the container. Inherited from Design.color |
| excludeContext | excludeContext: boolean (optional) |
|
| flexFlow | flexFlow: string (optional) |
Specifying this property makes the component a flex container component. Inherited from Design.flexFlow |
| flexSize | flexSize: string (optional) |
One number or two numbers written as a string. For example, "(size to grow) [(size-to-shrink)]" to accommodate available space in the immediate flex container. Inherited from Design.flexSize |
| fontSize | fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (optional) |
The proportional text size Inherited from Design.fontSize |
| fontWeight | fontWeight: "normal" | "bold" (optional) |
Normal or bold text. Inherited from Design.fontWeight |
| hideArrow | hideArrow: boolean (optional) |
Allows an arrow ( > ) on a default styled navigation control to be hidden. |
| icon | icon: string (optional) |
Name of the icon that is displayed in the pagelink control. |
| justifyItems | justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (optional) |
This property is an alias for the CSS property "justify-content". Inherited from Design.justifyItems |
| label | label: string (optional) |
Inherited from Design.label |
| labelPosition | labelPosition: "stacked" | "hidden" | "inline" (optional) |
Determines how a label is positioned, if at all. By default, labelPosition is set to stacked. Inherited from Design.labelPosition |
| name | name: string (optional) |
Inherited from Design.name |
| navigation | navigation: NavigationArgs (optional) |
Navigation object of the pagelink. |
| padding | padding: "none" | "small" | "std" (optional) |
Allows specifying the component's padding behavior. Inherited from Design.padding |
| showCount | showCount: boolean (optional) |
If true, shows a count of the records present in the list on the target page. |
| style | style: string (optional) |
Determines the visual style of the pagelink control. Options: * "inline": takes up the full width its container, with the label in-line with the icon * "button": takes up only as much width as needed by the label, with the label below the icon |
| type | type: ControlType (optional) |
The type of the control as a string. Inherited from Design.type |
PageLinkMetadata
Hierarchy
ControlMetadata
└─ PageLinkMetadata
Properties
| Name | Signature | Description |
|---|---|---|
| BoundEntity | BoundEntity: string (optional) |
The entity to which the control is bound. Inherited from ControlMetadata.BoundEntity |
| BoundField | BoundField: string (optional) |
Inherited from ControlMetadata.BoundField |
| Description | Description: string (optional) |
Description of the control. Inherited from ControlMetadata.Description |
| Editable | Editable: boolean (optional) |
Boolean indicating if the control is editable. Inherited from ControlMetadata.Editable |
| ExcludeContext | ExcludeContext: boolean (optional) |
|
| ExtType | ExtType: ControlType (optional) |
The extended control type. For example, a control of type Input might have an extended type of Barcode. Inherited from ControlMetadata.ExtType |
| HelpText | HelpText: string (optional) |
The keyboard shortcut for a command. For example, "(Shift+F5)" Inherited from ControlMetadata.HelpText |
| Hidden | Hidden: boolean (optional) |
Boolean indicating if the control is hidden or not. Inherited from ControlMetadata.Hidden |
| Icon | Icon: string (optional) |
Name of the icon that is displayed in the pagelink control. |
| IconSize | IconSize: number (optional) |
Determines the size of the icon that is displayed in the pagelink control. |
| Id | Id: string (optional) |
Identification string for a control. Inherited from ControlMetadata.Id |
| Label | Label: string (optional) |
Label for a control. For example, a control representing a person's first name might have a label "First Name". Inherited from ControlMetadata.Label |
| Name | Name: string (optional) |
Name of a control. Inherited from ControlMetadata.Name |
| Navigation | Navigation: NavigationArgs (optional) |
Navigation object of the pagelink. |
| Order | Order: number (optional) |
Number indicating the order in which a control will appear on a page. Inherited from ControlMetadata.Order |
| ShowCount | ShowCount: boolean (optional) |
If true, shows a count of the records present in the list on the target page. |
| Style | Style: string (optional) |
Determines the visual style of the pagelink control. |
| Target | Target: string (optional) |
Name of the target action or page to navigate to when the pagelink is selected. |
| Type | Type: ControlType (optional) |
String indicating the control type. Inherited from ControlMetadata.Type |
| UseDataContext | UseDataContext: boolean (optional) |
Events
| Name | Signature | Description |
|---|---|---|
| OnNavigate | OnNavigate: function(navigation: NavigationArgs | string): any (optional) |
An event that is triggered when the navigation is triggered. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for