smart-html-elements

Form Blazor API

Form Properties

Name	Type	Default	Description
Columns	int	1	Sets or gets the form columns.
Controls	IEnumerable<IControl>	N/A	Sets or gets the form controls.
OnStatusChanges	object	N/A	Callback function for handling status changes
OnValueChanges	object	N/A	Callback function for handling value changes
LabelPosition	FormLabelPosition	FormLabelPosition.Left	Sets or Gets the labels position.
Readonly	bool	false	Makes the form readonly.
ShowColonAfterLabel	bool	false	Shows / hides the colon after the labels.
ShowSummary	bool	true	Shows / hides validation summary.
State	object	N/A	Gets the Form's state. Each member in the state has { dirty, untouched, disabled } properties.
Value	object	N/A	Gets or Sets the Form value.

Form Methods

Name	Type	Arguments	Description
AddControl	void	object controlOptions	Adds a control to the Form.Args: object controlOptions - Control options. The control options description is available in the "controls" property.
GetControl	Control	string dataField	Gets a control by its name(dataField).Args: string dataField - dataField of a FormControl or FormGroup
GetValueAsync()	Task<object>	'N/A'	Gets the "Value" property as Task<object>.
InsertControl	void	int index, object controlOptions	Inserts a control to the Form.Args: int index - Control insert index,object controlOptions - Control options. The control options description is available in the "controls" property.
Refresh	void	'N/A'	Refreshes the Blazor Component. Performs a layout of the HTML Elements and recalculates the measurements.
RemoveControl	void	object controlOptions	Remove a control from the Form.Args: object controlOptions - Control options. The control options description is available in the "controls" property.
Render	void	'N/A'	Re-renders the Blazor Component. This method will make a full re-render.
Reset	void	N/A	Clears the form.
StateHasChanged	void	'N/A'	Refreshes the state and Re-renders the Blazor Component, if necessary.
Submit	void	object submitOptions	Submits the form.Args: object submitOptions - Sets the submit options object. The object may have the following properties: "async", "action", "target", "method". "async" determines whether the form will be submitted asynchronously. "action" determines the submit url, "method" sets whether the submit is through 'GET' or 'POST'. "target" determines the submit target.
Submit	void	N/A	Submits the form.
Validate	void	N/A	Validates the form.

Enums

ControlControlType

ControlControlType.Button

ControlControlType.Boolean

ControlControlType.ComboBox

ControlControlType.CheckInput

ControlControlType.Datetime

ControlControlType.DropDownList

ControlControlType.Group

ControlControlType.Input

ControlControlType.Label

ControlControlType.MultiInput

ControlControlType.MultiComboInput

ControlControlType.Mask

ControlControlType.Number

ControlControlType.Password

ControlControlType.RadioButton

ControlControlType.Submit

ControlControlType.Textarea

ControlControlType.Template

ControlControlControlType

ControlControlControlType.Button

ControlControlControlType.Boolean

ControlControlControlType.ComboBox

ControlControlControlType.CheckInput

ControlControlControlType.Datetime

ControlControlControlType.DropDownList

ControlControlControlType.Group

ControlControlControlType.Input

ControlControlControlType.Label

ControlControlControlType.MultiInput

ControlControlControlType.MultiComboInput

ControlControlControlType.Mask

ControlControlControlType.Number

ControlControlControlType.Password

ControlControlControlType.RadioButton

ControlControlControlType.Submit

ControlControlControlType.Textarea

ControlControlControlType.Template

ControlControlLabelPosition

ControlControlLabelPosition.Left

ControlControlLabelPosition.Top

ControlControlViewMode

ControlControlViewMode.Null

ControlControlViewMode.Accordion

ControlControlViewMode.Tabs

ControlControlViewMode.Breadcrumb

ControlLabelPosition

ControlLabelPosition.Left

ControlLabelPosition.Top

ControlViewMode

ControlViewMode.Null

ControlViewMode.Accordion

ControlViewMode.Tabs

ControlViewMode.Breadcrumb

FormLabelPosition

FormLabelPosition.Left

FormLabelPosition.Top

Control Properties

Name	Type	Default	Description
Append	string	""	HTML Content displayed after the Form Control
ControlOptions	object	null	JSON object with initialization properties of the UI component. Example: { dataSource: ['item 1', 'item 2', 'item 3'] } will set the dataSource property of the Form control.
ControlType	ControlControlType	ControlControlType.Input	The type of the control.
Columns	int	1	Sets the Form Group columns.
ColumnSpan	int	1	Sets the Form control column span.
Controls	IEnumerable<IControlControl>	null
DataField	string	""	Sets the Form control data field. The control's inner input's name is set to the dataField value and in the FormGroup it is accessible through the dataField value.
Disabled	bool	false	Sets the Form control disabled mode.
Dirty	bool	false	Gets whether the Form control is 'dirty' i.e its value is changed by the user.
Info	string	""	Gets or Sets the Form control's info icon's tooltip.
Invalid	bool	false	Gets whether the Form control is invalid.
Label	string	""	Gets or Sets the Form control's label.
LabelPosition	ControlLabelPosition	ControlLabelPosition.Left	Gets or Sets the Form control's label position.
LabelOffset	int	10	Gets or Sets the offset between the label and the control.
LabelAlign	string	"left"	FormGroup only(when controlType is set to 'group'). Gets or Sets whether the navigation buttons are displayed. The property has effect when the viewMode property is set.
NextButtonLabel	string	"Next"	FormGroup only(when controlType is set to 'group'). Gets or Sets the next button label.
BackButtonLabel	string	"Back"	FormGroup only(when controlType is set to 'group'). Gets or Sets the back button label.
Prepend	string	""	HTML Content displayed before the Form Control
Readonly	bool	false	Gets or Sets the Form control readonly mode.
Untouched	bool	false	Gets whether the Form control is not touched by the user. This flag is changed usually on blur, after the user interacted with the Form control
Placeholder	string	""	Gets or Sets the placeholder.
ShowButtons	bool	false	FormGroup only(when controlType is set to 'group'). Gets or Sets whether the navigation buttons are displayed. The property has effect when the viewMode property is set.
Value	object	null	Sets or Gets the Form control or Form group value.
Valid	bool	false	Gets whether the Form control is valid.
ValidationRules	IEnumerable<object>	null	Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
ViewMode	ControlViewMode	ControlViewMode.Null	FormGroup only(when controlType is set to 'group'). Gets or Sets the form'group view mode.

ControlControl Properties

Name	Type	Default	Description
Append	string	""	HTML Content displayed after the Form Control
ControlOptions	object	null	JSON object with initialization properties of the UI component. Example: { dataSource: ['item 1', 'item 2', 'item 3'] } will set the dataSource property of the Form control.
ControlType	ControlControlControlType	ControlControlControlType.Input	The type of the control.
Columns	int	1	Sets the Form Group columns.
ColumnSpan	int	1	Sets the Form control column span.
DataField	string	""	Sets the Form control data field. The control's inner input's name is set to the dataField value and in the FormGroup it is accessible through the dataField value.
Disabled	bool	false	Sets the Form control disabled mode.
Dirty	bool	false	Gets whether the Form control is 'dirty' i.e its value is changed by the user.
Info	string	""	Gets or Sets the Form control's info icon's tooltip.
Invalid	bool	false	Gets whether the Form control is invalid.
Label	string	""	Gets or Sets the Form control's label.
LabelPosition	ControlControlLabelPosition	ControlControlLabelPosition.Left	Gets or Sets the Form control's label position.
LabelOffset	int	10	Gets or Sets the offset between the label and the control.
LabelAlign	string	"left"	FormGroup only(when controlType is set to 'group'). Gets or Sets whether the navigation buttons are displayed. The property has effect when the viewMode property is set.
NextButtonLabel	string	"Next"	FormGroup only(when controlType is set to 'group'). Gets or Sets the next button label.
BackButtonLabel	string	"Back"	FormGroup only(when controlType is set to 'group'). Gets or Sets the back button label.
Prepend	string	""	HTML Content displayed before the Form Control
Readonly	bool	false	Gets or Sets the Form control readonly mode.
Untouched	bool	false	Gets whether the Form control is not touched by the user. This flag is changed usually on blur, after the user interacted with the Form control
Placeholder	string	""	Gets or Sets the placeholder.
ShowButtons	bool	false	FormGroup only(when controlType is set to 'group'). Gets or Sets whether the navigation buttons are displayed. The property has effect when the viewMode property is set.
Value	object	null	Sets or Gets the Form control or Form group value.
Valid	bool	false	Gets whether the Form control is valid.
ValidationRules	IEnumerable<object>	null	Sets or gets the column's validation rules. The expected value is an Array of Objects. Each object should have a 'type' property that can be set to 'required', 'min', 'max', 'minLength', 'maxLength', 'email', 'null', 'requiredTrue', 'minData', 'maxDate', 'pattern'. The 'value' property should be set, too. For validation rule types 'required', 'requiredTrue' and 'null' you can skip the 'value' property. Optional property is 'message', which determines the error message.
ViewMode	ControlControlViewMode	ControlControlViewMode.Null	FormGroup only(when controlType is set to 'group'). Gets or Sets the form'group view mode.

Complex Components

Core Components