Introduction
- 18 Sep 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Introduction
- Updated on 18 Sep 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Description
The app object allows you to interact with your app and its objects directly.
Properties
Below is a list of properties supported by this object.
| Name | Description | UWP | Web | Avatars |
|---|---|---|---|---|
| name | Returns the name of your app | Yes | Yes | Yes |
| version | Returns the version of your app | Yes | Yes | Yes |
| pageCount | Returns the total # of pages in your app's layout | Yes | Yes | Yes |
| pageIndex | Returns the index of the active page in your app's layout | Yes | Yes | No |
| pageTitle | Returns the title of the active page in your app's layout | Yes | Yes | No |
Functions
Below is a list of functions supported by this object.
| Name | Description | UWP | Web | Avatars |
|---|---|---|---|---|
| find | Returns a specified app object | Yes | Yes | Yes |
| get | Returns a specified app object's value or a mapped curated needle value | Yes | Yes | Yes |
| set | Sets a specified app object's value | Yes | Yes | Yes |
| load | Loads multiple app object values from a single passed object | Yes | Yes | Yes |
| listen | Registers specified app objects to listen for change events | Yes | Yes | No |
| link | Links two groups of app objects together for a specified purpose | Yes | Yes | No |
| unlink | Unlinks two groups of app objects from each other that have an existing relationship via app.link | Yes | Yes | No |
| enable | Toggles the enabled status of the specified app object(s) | Yes | Yes | No |
| visible | Toggles the visibility of the specified app object(s) | Yes | Yes | No |
| paint | Paints (colors) the specified app object(s) | Yes | Yes | No |
| plot | Renders a plot visualization to a specified Picture app object | Yes | Yes | No |
| selected | Returns whether or not the specified app object has a valid value | Yes | Yes | Yes |
| selectedAll | Returns whether or not all of the specified app objects have valid values | Yes | Yes | Yes |
| selectedAny | Returns whether or not any of the specified app objects have valid values | Yes | Yes | Yes |
| transcribe | Transcribes a specified app object's language | Yes | Yes | Yes |
| Name | Description | UWP | Web | Avatars |
|---|---|---|---|---|
| locker.download | Downloads a specified resource from your app's locker | Yes | Yes | Yes |
Remarks
Use the app object to interact with your app and its objects directly.
Accomplish tasks such as:
- Listen for user input changes and take appropriate actions
- Get, set, and validate user input values
- Make suggestions to the user by painting user inputs based on logic
- Modify your app's output language just before it is rendered
- And much more!