FieldInclusion property

ServerRelayButton.FieldInclusion — FieldInclusion

Special value available in formulas:

Item

ServerRelayButton

The button this property is part of, enabling multiple checked items in the app designer to share the same formula and be updated all at once.

Consider the fields Field1 and Field2, which should only be considered to be valid if their values are greater than 4. Without using the Item value, the Valid property of Field1 would need to use the formula Field1 > 4Field1 > 4 and the Valid property of Field2 would need to use the formula Field2 > 4Field2 > 4.

Using Item, both formulas can read Item > 4Item > 4. This is useful if you have many fields and you want to be able to update their formulas all at once. To do so, click their check boxes in Calcapp Creator and make sure that a checked field is selected. Then, when you update a formula for one checked field, you update all the other checked fields too, which is a great timesaver.

Use Item in exactly the same way you'd use the regular name. Button1.VisibleButton1,Visible and Item.VisibleItem,Visible are equivalent, for instance.

Which fields are sent to a server. These are the allowed values:

Value Meaning
FieldInclusion.​Screen Sends all fields that are on the same screen as the button.
FieldInclusion.​All Sends all fields of the app.
FieldInclusion​.​Custom Sends only the fields returned by the IncludedFields property.

Examples

IF(Field1 > 4, FieldInclusion.All, FieldInclusion.Custom)IF(Field1 > 4; FieldInclusion,All; FieldInclusion,Custom)

Makes a server relay button send all fields if the value of Field1 is greater than 4. Otherwise, only the fields returned from the IncludedFields property are sent.

RELAY(IF(Field1 > 4, { App }, ServerRelayButton1.IncludedFields), ServerRelayButton1.Address)RELAY(IF(Field1 > 4; { App }; ServerRelayButton1,IncludedFields); ServerRelayButton1,Address)

This formula is associated with the OnPress property of a formula button, and causes certain fields to be sent to a server when the button is pressed. All fields are sent if the value of Field1 is greater than 4. Otherwise, only the fields returned from the IncludedFields property are sent.