PageLinkMetadata Type

Pagelink metadata type.

Hierarchy

ControlMetadata
   └─ PageLinkMetadata

Index

Properties

Events

Properties

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. False when either the control or it's parent is not editable. True when both the control and it's parent are editable. True when either the control or it's parent is editable and the other is undefined. Undefined if both the control's edit-ability and it's parent's edit-ability is undefined.

Inherited from ControlMetadata.Editable

ExcludeContext

ExcludeContext: boolean (optional)

ExtType

ExtType: ControlType (optional)

The extended control type. E.g. 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. E.g. "(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. Here is a list of available icons.

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. E.g. 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: 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. This property is only suitable when the navigation target is a Page which contains on a List control.

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

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

OnNavigate

OnNavigate: function(navigation: NavigationArgs | string): any (optional)

An event that is triggered when the navigation is triggered.