Class FormFieldRenderingConfiguration
Configuration describing rendering of optional wrapping HTML elements for Form builder's form field.
public class FormFieldRenderingConfiguration
- Inheritance
-
objectFormFieldRenderingConfiguration
- Extension Methods
Fields
GetConfiguration
An event raised upon getting rendering configuration of a form field on live site. Allows for modification of Configuration for rendering the specified FormComponent.
public static readonly GetFormFieldRenderingConfigurationHandler GetConfiguration
Field Value
Properties
ColonAfterLabel
Gets or sets a value indicating whether a colon is rendered after 'label' element. True by default.
public bool ColonAfterLabel { get; set; }
Property Value
- bool
ComponentWrapperConfiguration
Gets or sets the rendering configuration of an element wrapping the form's 'editor' element.
public ElementRenderingConfiguration ComponentWrapperConfiguration { get; set; }
Property Value
Default
Gets or sets the default form rendering configuration. The default configuration wraps the form field in a 'div' element with no attributes and renders a colon after the label. The configuration can be adjusted for individual form components using the GetConfiguration event.
public static FormFieldRenderingConfiguration Default { get; set; }
Property Value
EditorHtmlAttributes
Gets or sets HTML attributes for the form's 'editor' element. An empty dictionary by default.
public IDictionary<string, object> EditorHtmlAttributes { get; set; }
Property Value
- IDictionary<string, object>
EditorWrapperConfiguration
Gets or sets the rendering configuration of an element wrapped in ComponentWrapperConfiguration and the corresponding 'explanation text'.
public ElementRenderingConfiguration EditorWrapperConfiguration { get; set; }
Property Value
ExplanationTextWrapperConfiguration
Gets or sets the rendering configuration to the explanation text of a form field.
public ElementRenderingConfiguration ExplanationTextWrapperConfiguration { get; set; }
Property Value
LabelHtmlAttributes
Gets or sets the HTML attributes for the form's 'label' element. An empty dictionary by default.
public IDictionary<string, object> LabelHtmlAttributes { get; set; }
Property Value
- IDictionary<string, object>
LabelWrapperConfiguration
Gets or sets the rendering configuration of an element wrapping the form's 'label' element.
public ElementRenderingConfiguration LabelWrapperConfiguration { get; set; }
Property Value
RootConfiguration
Gets or sets the rendering configuration of an element wrapping the form's field. A field consists of a label and an editor.
public ElementRenderingConfiguration RootConfiguration { get; set; }
Property Value
ShowSmartFieldIcon
Gets or sets a value indicating whether a smart field icon is rendered for smart fields.
public bool ShowSmartFieldIcon { get; set; }
Property Value
- bool
SmartFieldIconHtmlAttributes
Gets or sets HTML attributes for the smart field icon. An empty dictionary by default.
public IDictionary<string, object> SmartFieldIconHtmlAttributes { get; set; }
Property Value
- IDictionary<string, object>
SmartFieldIconWrapperConfiguration
Gets or sets the rendering configuration of an element wrapping the smart icon element.
public ElementRenderingConfiguration SmartFieldIconWrapperConfiguration { get; set; }
Property Value
SuppressValidationMessages
When true no validation messages are rendered for the fields. This way validation messages may be handled from outside of the form field.
public bool SuppressValidationMessages { get; set; }
Property Value
- bool
Widget
Gets rendering configuration for a widget field. The configuration can be adjusted for individual form components using the GetConfiguration event.
public static FormFieldRenderingConfiguration Widget { get; set; }