Skip to main content
CYPEX Documentation
Support
v2.0.0 Latest stable release View changelog ->
Various Referencegenerated

Internal Link Field

Display a Link Button

Technical id
default_internal_link_field
Default size
1 × 1 cells

A data-aware detective anchor hyperlink that looks like standard underlined body text by default, pulling specific row criteria parameters to compute dynamic page transfers.

When to use

  • Navigating users dynamically to specific record detail views by extracting unique row variables from the current screen context (e.g., clicking a specific product row to go to its unique page).
  • Building smart, data-aware text links inside tables, list rows, or informational cards that require identifier parameter interpolation.

What you need

Requires binding a relational query name source, choosing the underlying primary target identifier column, and passing an active evaluation expression to capture runtime row values.

  • Contextual database records, view grids, or repeating layout lists where row data properties must be passed into subsequent routing parameters.

Examples

  • A smart tabular text grid hyperlink labeled with the client’s name that dynamically loads their detailed profile using a row evaluation script.
  • An automated text summary link that opens a targeted invoice detail screen by passing the active record’s primary ID track.

Avoid

  • Using as a simple hardcoded global routing option (e.g., ‘Go to Home Screen’) without any backing row variables, use the internal_link_button instead.
  • Leaving the Identifier Value unmapped, which breaks the relational linking mapping mechanism and loads blank page routes.

Use instead

  • Internal Link Button — The navigation endpoint is a static global page target (like Settings or Dashboard) that requires hardcoded destinations with standard button sizes and color wardrobe parameters independent of row data state logs.

Editor properties

Configure these in the Application Designer property panel. Group headings mirror the editor where possible. Data Source is where the element gets its rows or field binding (a view/query, a connector operation, or a parent form field). References appear only for view-backed sources and map foreign-key ID columns to readable labels from another view.

Data Source
Database view that supplies rows or form data.
Default: none
Primary-key field used to load a single record (edit/detail).
Default: none
Expression resolving the record id (often from URL query).
Example currentRecord.id
Default: none
Translation
The visible anchor text string representing the link. Restricted strictly to expression logic parsing lines.
Example LabelName
Default: buildCustomExpressionValue('"Label"')
Setup
Target page id in the application menu.
Default: none
Query parameters passed to the target page.
Default: {}
When true, the control cannot be edited.
Example false
Default: none
Styling
Visual style option override switch that alters the element’s default inline anchor tag footprint to resemble standard colored platform buttons.
Default: none

Sizing

  • Minimum size: 1 × 1 grid cells (width × height).
  • Default size when dropped on a page: 1 × 1.

Accessibility

Renders standard semantic anchor bindings. Broadcasts dynamic value target contexts to screen reading tech whenever expressional variables resolve active page states.

  • Fires contextual router parameter hooks instantly upon targeting and hitting Enter key components.

Values you can read in expressions

Other parts of your app can read live values from this element in custom expressions:

elements.myInternalLinkField.<property>

loading boolean True while data is loading from the server. elements.myInternalLinkField.loading
data any Current payload rows or record object. elements.myInternalLinkField.data
error string Error message when the last operation failed. elements.myInternalLinkField.error
identifier any Resolved primary-key value for the loaded record. elements.myInternalLinkField.identifier

When The key of the record this link points at, useful when a sibling element needs to show the same target.

hasStarted boolean True once navigation to the linked page has begun. elements.myInternalLinkField.hasStarted

To use one of these, open the property you want to drive on the other element, switch it to expression mode in the Expression Editor, and enter:

1
elements.myInternalLinkField.data

Replace myInternalLinkField with this element’s unique id. Select the element in Application Designer and copy the id chip at the top of the right-hand property panel.

Where you can place it

Drag this element into one of these containers:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "config": {
    "linkTo": {
      "pageId": "overview",
      "params": {
        "exampleKey": "@@expression:'value'"
      }
    },
    "label": "Name"
  }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
{
  "config": {
    "linkTo": {
      "pageId": "overview",
      "params": {
        "exampleKey": "@@expression:'value'"
      }
    },
    "label": "Name",
    "dataSource": {
      "viewName": "contacts",
      "identifierName": "identifierName"
    },
    "identifierValue": "@@expression:'value'",
    "isButton": false,
    "disabled": "@@expression:true"
  }
}

Ready-made setups

Configuring a contextual data-bound smart field linking rows directly to an entry profile page by tracking record keys.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "config": {
    "data_source": {
      "queryName": "getUserManifestList",
      "identifierName": "uuid",
      "identifierValue": "@@expression: currentItem.uuid"
    },
    "translation": {
      "labelExpression": "@@expression: currentItem.userName"
    },
    "setup": {
      "linkToPageId": "user_profile_detail_view",
      "disabled": "@@expression: false"
    },
    "styling": {
      "displayAsButton": false
    }
  }
}

Notes

Description

The InternalLinkField is used to display a link button to internal page

config

propertytypedescriptionrequired
linkTo{ pageId: string, params: { [x: string]: string }The internal link page with its params✔️
labelstringThe display label✔️