title | description | author | ms.author | ms.topic | ms.date | ms.reviewer | audience | ms.search.region |
---|---|---|---|---|---|---|---|---|
PageLink type |
Learn about the pagelink control type. A pagelink is a control that navigates to another page and includes various properties and methods. |
jasongre |
jasongre |
article |
05/24/2022 |
johnmichalak |
Developer |
Global |
[!include banner] [!include mobile app deprecated]
Pagelink control type. A pagelink is a control that navigates to another page.
Control
└─ PageLink
- allowsNavigation
- applyDesign
- dataContext
- getCount
- getDesign
- getNavigationHandler
- isEditable
- metadata
- parent
- root
- showCount
container: boolean (optional)
True if the control is a container.
generic: boolean (optional)
getDataSource: function(): any
Inherited from Control.getDataSource
hidden
hidden: boolean
True if the control is hidden.
allowsNavigation(): boolean
applyDesign(design: PageLinkDesign): void
Applies given design to the design on the control. If a design already exists, the prototype chain of the design will be preserved.
Overrides Control.applyDesign
Name | Type | Description |
---|---|---|
design | PageLinkDesign | object containing design properties as keys |
dataContext(): any
Inherited from Control.dataContext
getCount(): number | string
getDesign(): Design
Returns the design object of this control.
Returns Design
getNavigationHandler(): NavigationArgs
Returns NavigationArgs
isEditable(): boolean
Boolean indicating if the control is editable. Returns false when either the control or its parent is not editable. Returns true when both the control and its parent are editable. Returns true when either the control or its parent is editable and the other is undefined. Returns undefined if both the control's edit-ability and its parent's edit-ability is undefined.
Inherited from Control.isEditable
metadata(): PageLinkMetadata
Returns the metadata object of this control.
Returns PageLinkMetadata
Returns the parent (control or page) of this control.
root(): Page
Returns the root form instance (page) of this control.
Returns Page
showCount(): boolean
[!INCLUDEfooter-include]