FormLayoutFunction

FormLayoutFunction

is an option for FormObject and FormFunction that can be used to specify how to lay out a form.

Details

  • FormLayoutFunction is a pure function that is applied to the FormObject to extract the layout.
  • Various pieces of the layout can be extracted by either FormObject[][key], which extracts the complete field, or FormObject[][key,prop], where prop can be one of the following:
  • "Control"bare control of the field, e.g. InputForm
    "Label"unformatted label of the field
    "Help"help text associated with the field
    "Failure"message of the current failure, if applicable
    "Required"whether the field is required for submission
    "Hint"hint text, usually associated with the FieldHint option
    "Masked"whether to mask the field (see FieldMasked)
    "Hidden"whether a field should be hidden
  • Other pieces of the layout are stored in the AppearanceRules and can be accessed by using FormObject[][AppearanceRules,prop].
  • AppearanceRules can contain arbitrary key-value pairs, but typical values of prop include:
  • "Title"Noneoverall title for the form
    "Description"Nonedescription to include at the top of the form
    "RequiredFieldIndicator"Noneindicator to show required fields
    "SubmitLabel""Submit"text for the submit button
    "CancelLabel""Cancel"text for the cancel button
    "ItemLayout""Horizontal"layout for a single element

Examples

Basic Examples  (3)

Create a custom layout and style the elements:

Complete fields can be accessed by their key:

Single elements of the complete field can be individually accessed as well:

Wolfram Research (2014), FormLayoutFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/FormLayoutFunction.html.

Text

Wolfram Research (2014), FormLayoutFunction, Wolfram Language function, https://reference.wolfram.com/language/ref/FormLayoutFunction.html.

CMS

Wolfram Language. 2014. "FormLayoutFunction." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/FormLayoutFunction.html.

APA

Wolfram Language. (2014). FormLayoutFunction. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/FormLayoutFunction.html

BibTeX

@misc{reference.wolfram_2023_formlayoutfunction, author="Wolfram Research", title="{FormLayoutFunction}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/FormLayoutFunction.html}", note=[Accessed: 19-March-2024 ]}

BibLaTeX

@online{reference.wolfram_2023_formlayoutfunction, organization={Wolfram Research}, title={FormLayoutFunction}, year={2014}, url={https://reference.wolfram.com/language/ref/FormLayoutFunction.html}, note=[Accessed: 19-March-2024 ]}