Reference property

SwitchField.Reference — SwitchField

Returns a reference to the switch field.

Referencing a switch field is useful when writing formulas for the IncludedFields property of download report buttons, e-mail report buttons, server relay buttons and reset buttons. When a switch field is referenced from these formulas, it is made part of a report, is sent to a server or is reset, depending on the button.

This property is a read-only property, meaning that no formula can be assigned to it.

Referencing switch fields from formulas

When referencing a switch field from a formula, there is no need to write .Reference,Reference after the field name if a reference is sought. These formulas are equivalent when associated with the IncludedFields property of email report buttons:

{ SwitchField1, SwitchField2 }{ SwitchField1; SwitchField2 }
{ SwitchField1.Reference, SwitchField2.Reference }{ SwitchField1,Reference; SwitchField2,Reference }

Above, the IncludedFields property is looking for an array of references. As SwitchField1 and SwitchField2 can return references through their Reference properties, .Reference,Reference is implied.

Examples

{ SwitchField1 }{ SwitchField1 }

This formula is associated with the IncludedFields property of a download report button and causes the referenced switch field to be included in the report.

{ SwitchField1.Reference }{ SwitchField1,Reference }

This formula is associated with the IncludedFields property of a download report button and causes the referenced switch field to be included in the report. Writing out the Reference property in formulas (by writing SwitchField1.ReferenceSwitchField1,Reference) is rarely necessary.

IF(ResetAllFields, { App }, SwitchField1:SwitchField10)IF(ResetAllFields; { App }; SwitchField1:SwitchField10)

This formula is associated with the IncludedFields property of a reset button. If the ResetAllFields switch field is toggled to its "on" position, all fields of the app are reset (courtesy of AppApp being part of the first array). Otherwise, only SwitchField1, SwitchField10 and all fields that appear between them are reset.