Class FormEventArgs

Specifies the form event arguments for input validation events.

Inheritance

object

FormEventArgs

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Inputs

Assembly: Syncfusion.Blazor.dll

Syntax

public class FormEventArgs

Remarks

This class provides comprehensive information about form validation events, including details about the input element, error messages, and validation status. It is commonly used in form validation scenarios to handle validation results and provide feedback to users.

Constructors

FormEventArgs()

Declaration

public FormEventArgs()

Properties

Element

Gets or sets the input element associated with the form validation event.

Declaration

[JsonPropertyName("element")]
public DOM Element { get; set; }

Property Value

Type	Description
DOM	A DOM object representing the input element, or `null` if no element is available.

Remarks

This property provides access to the DOM element that triggered the validation event, allowing for direct manipulation or inspection of the input element's properties and attributes.

ErrorElement

Gets or sets the error element that displays validation messages for the corresponding input.

Declaration

[JsonPropertyName("errorElement")]
public DOM ErrorElement { get; set; }

Property Value

Type	Description
DOM	A DOM object representing the error display element, or `null` if no error element exists.

Remarks

The error element is typically used to show validation messages to users. This property allows access to the specific DOM element where error messages are rendered for styling or content manipulation.

InputName

Gets or sets the name attribute value of the input element.

Declaration

[JsonPropertyName("inputName")]
public string InputName { get; set; }

Property Value

Type	Description
string	A string containing the name of the input element, or `null` if no name is specified.

Remarks

The input name is used to identify the form field and is essential for form submission and validation processing. This property helps in associating validation results with specific form fields.

Message

Gets or sets the validation error message associated with the form event.

Declaration

[JsonPropertyName("message")]
public string Message { get; set; }

Property Value

Type	Description
string	A string containing the error message, or `null` if no error message is available.

Remarks

This property contains the descriptive error message that explains the validation failure. The message can be displayed to users to help them understand what needs to be corrected in their input.

Status

Gets or sets the validation status of the input element.

Declaration

[JsonPropertyName("status")]
public string Status { get; set; }

Property Value

Type	Description
string	A string indicating the validation status (e.g., "valid", "invalid", "pending"), or `null` if status is undetermined.

Remarks

The status property provides information about the current validation state of the input element, allowing developers to implement appropriate visual feedback and behavior based on the validation result.