FieldInfo
FieldInfo class
Stores information about fields for the DataObject class.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
global class FieldInfo
The FieldInfo class exposes the following members.
Constructors
| Member name |
Description |
|---|---|
| FieldInfo | Creates an instance of the FieldInfo class, using the specified name and field type of the field represented by the instance. |
Properties
| Member name | Description |
|---|---|
| FieldInfo.fieldType property | Gets or sets the field type of the field represented by the FieldInfo instance. |
| FieldInfo.isHtmlFormatted property | Gets or sets whether the field represented by the FieldInfo instance should be formatted for HTML. |
| FieldInfo.label property | Gets or sets the text label of the field represented by the FieldInfo instance. |
| FieldInfo.name property | Gets or sets the name of the field represented by the FieldInfo instance. |
| FieldInfo.referenceTo property | Gets or sets the name of the parent object for the field represented by the FieldInfo instance. |
| FieldInfo.scale property | Gets or sets the scale of the field represented by the FieldInfo instance. |
Remarks
This class is defined within the ExternalData class.
FieldInfo constructor
Creates an instance of the FieldInfo class, using the specified name and field type of the field represented by the instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
FieldInfo(String name, Schema.DisplayType type)
Parameters
name
Type: String
The name of the field represented by the FieldInfo instance.
type
Type: Schema.DisplayType
The field type of the field represented by the FieldInfo instance.
FieldInfo properties
The FieldInfo class exposes the following members.
Properties
| Member name | Description |
|---|---|
| FieldInfo.fieldType property | Gets or sets the field type of the field represented by the FieldInfo instance. |
| FieldInfo.isHtmlFormatted property | Gets or sets whether the field represented by the FieldInfo instance should be formatted for HTML. |
| FieldInfo.label property | Gets or sets the text label of the field represented by the FieldInfo instance. |
| FieldInfo.name property | Gets or sets the name of the field represented by the FieldInfo instance. |
| FieldInfo.referenceTo property | Gets or sets the name of the parent object for the field represented by the FieldInfo instance. |
| FieldInfo.scale property | Gets or sets the scale of the field represented by the FieldInfo instance. |
FieldInfo.fieldType property
Gets or sets the field type of the field represented by the FieldInfo instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
String fieldType
Property Value
Type: String
The string value of the field type for the field represented by the FieldInfo instance.
Remarks
The value of this property corresponds to the string value of the Schema.DisplayType enumeration value specified in the type parameter of the FieldInfo constructor when the FieldInfo instance was created.
FieldInfo.isHtmlFormatted property
Gets or sets whether the field represented by the FieldInfoinstance should be formatted for HTML.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
Boolean isHtmlFormatted
Property Value
Type: Boolean
true if the field should be formatted for HTML and encoded for display in HTML; otherwise, false
FieldInfo.label property
Gets or sets the text label of the field represented by the FieldInfo instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
String label
Property Value
Type: String
The text of the label displayed in the Field Tagger, next to the field represented by the FieldInfo instance. If a value is not specified, the name of the field is displayed in the label.
FieldInfo.name property
Gets or sets the name of the field represented by the FieldInfo instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
String name
Property Value
Type: String
The name of the field represented by the FieldInfo instance.
Remarks
The value of this property corresponds to the string specified in the name parameter of the FieldInfo constructor when the FieldInfo instance was created.
FieldInfo.referenceTo property
Gets or sets the name of the parent object for the field represented by the FieldInfo instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
String referenceTo
Property Value
Type: String
The name of the parent object for the field represented by the FieldInfo instance.
FieldInfo.scale property
Gets or sets the scale of the field represented by the FieldInfo instance.
Namespace: LOOP
Package: Nintex DocGen for Salesforce
Syntax
integer scale
Property Value
Type: integer
For numeric fields, the number of digits allowed to the right of the decimal point for the numeric field represented by the FieldInfo instance; otherwise, this property is ignored.
Remarks
For numeric fields, the scale represents the number of digits to the right of the decimal point. Any extra digits to the right of the decimal point are truncated.