Note: Nintex Apps data centers are located in West US and Australia (AUS). In-region processing of Nintex Apps data is only available in these regions.
All code samples below refer to the skuid object.
In the v2 API, this object is not directly accessible when working within a browser console—or when referring to another Nintex Apps page runtime.
If you are experiencing issues, use the skuid.runtime API to target the appropriate page context.
skuid.ui
Classes
skuid.ui.Field
A Field is an object which represents a single value associated with a record which is stored within an sObject. The Field exposes a value, the context for that value and the record with which the value is associated, among other things.
See skuid.ui.Field
Properties
---
skuid.ui.Field
A Field is an object which represents a single value associated with a record which is stored within an sObject. The Field exposes a value, the context for that value and the record with which the value is associated and, generally, a UI element to edit that field.Constructor
new skuid.ui.Field(row,model,editor,config)
Instantiates a new Field that can generate an HTML element for displaying / interacting with a particular field on a particular row in a particular model. The Nintex Apps JavaScript equivalent of the <apex:inputField> tag.
Example:
// Get a reference to the model and row we'll be working with
var model = skuid.model.getModel('AccountData'),
row = model.getFirstRow();
// Creating an editor is for advanced scenarios.
// You typically set this to null.
var editor = null;
// Create a new skuid.ui.Field
// corresponding to the 'MailingCity' field
var f = new skuid.ui.Field(
row,
model,
editor,
{
fieldId: 'MailingCity',
register: true
}
);
// Render the field, running the corresponding field renderer logic
// using the metadata found for the 'MailingCity' field.
f.render();
Properties
| Property | Type | Required | Description |
|---|---|---|---|
| skuid.ui.searchableDisplayTypes | object | No |
Read-Only. A map of display types that can be used to search for records. As of the Spring '14 release, the following display types are included:
Use the following code to test if a skuid.ui.Field can be used for searching: Copy |
| skuid.ui.Field.editor | skuid.ui.Editor | No |
The skuid.ui.Editor associated with the field, if any. This will be populated for most standard Nintex Apps Fields (e.g. Fields in a Field Editor or Table). |
| skuid.ui.Field.element | $( DOM Element ) | No |
A jQuery wrapped DOM element representing the parent node for the field. Add HTML content to element to have it displayed in the appropriate place on the screen. Note: Elements directly associated with a Field will have a reference to the Field stored in the jQuery object data attribute. For example, to get at the Field corresponding to the first < td > element in the first row of a Table Component with ID "table-id", you could do $('#table-id tr:first-child > td:first-child').data('object'). |
| skuid.ui.Field.id | string | No |
The field API name. e.g. "FirstName", "CreatedBy", "CustomField__c" |
| skuid.ui.Field.item | skuid.ui.Item | No |
A skuid.ui.Item object representing the list item associated with the row to which the current field belongs. |
| skuid.ui.Field.label | string | No |
The field label as defined by the "Custom Label" property from the Page Designer or as defined by the Salesforce sObject field result metadata. |
| skuid.ui.Field.metadata | Nintex Apps Model Field Metadata Object | No |
Metadata about the field. |
| skuid.ui.Field.mode | string | No |
The Nintex Apps display mode to use when rendering this Field. One of:
|
| skuid.ui.Field.model | skuid.model.Model | No |
The skuid.model.Model from which the current Field is derived. |
| skuid.ui.Field.name | name | No |
The field alias. This is usually only used for aggregate queries. |
| skuid.ui.Field.required | boolean | No |
Indicates if the field is required, as specified either by the Page Designer or the Salesforce field's metadata. Required fields will be wrapped in a red border to indicate that they must have some value in them in order for the corresponding Model to be saved. |
| skuid.ui.Field.row | object | No |
The data row that this skuid.ui.Field is editing on its model, represented as a JavaScript object containing a simple mapping of field names to field values for the current row. For example, the current row of a Model with fields "Name" and "CustomField__c" would be represented as: Copy |
Prototype Functions
skuid.ui.Field.render()
Renders the field, creating or modifying field.element, a DOM element. Runs the appropriate field renderer logic based on the specified data field's metadata and the field's current mode.
For example: - If field.id were 'MailingCity' on the Account object, and field.mode were 'edit' , then the ('TEXT')['edit'] renderer would be used. - If field.id were 'CreatedDate' and field.mode were 'readonly' , then the ('DATETIME')['readonly'] renderer would be used.
Overriding Field Prototype Functions
Nintex Apps Fields have one prototype method that may need to be overriden: handleChange().
Note: This will only be called by Nintex Apps if the skuid.ui.Field is registered on a particular model. If a change is made to the skuid.ui.Field's corresponding row and field in that model, then Nintex Apps will call the skuid.ui.Field's handleChange() method as soon as the model has finished processing the change.
handleChange() is only called by Models as a result of calls to the Model updateRow() method -- handleChange is NOT called after calls to the Model save(), cancel(), or updateData() methods. However, render() WILL be called after save(), cancel(), or updateData(), as a given Field's DOM element will be completely rebuilt as a result of these three events.
skuid.ui.Field.handleChange(newValue)
By default, re-renders the Field. Override this method if using the Field as a Listener and you want to perform some custom logic based on the new value for the Field.| Arguments: |
|---|
|