FieldCssClassProvider.GetFieldCssClass(EditContext, FieldIdentifier) Method

Definition

Namespace:
Microsoft.AspNetCore.Components.Forms
Assembly:
Microsoft.AspNetCore.Components.Web.dll
Package:
Microsoft.AspNetCore.Components.Web v10.0.0
Package:
Microsoft.AspNetCore.Components.Web v11.0.0-preview.5.26302.115
Package:
Microsoft.AspNetCore.Components.Web v5.0.9
Package:
Microsoft.AspNetCore.Components.Web v6.0.6
Package:
Microsoft.AspNetCore.Components.Web v7.0.5
Package:
Microsoft.AspNetCore.Components.Web v8.0.19
Package:
Microsoft.AspNetCore.Components.Web v9.0.8
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs
Source:
FieldCssClassProvider.cs

Gets a string that indicates the status of the specified field as a CSS class. The result is one of "valid", "invalid", "pending", or "faulted", optionally prefixed with "modified " when IsModified(FieldIdentifier) is true.

  • "pending" is emitted while an async validation task registered via AddValidationTask(FieldIdentifier, Task, CancellationTokenSource) is in flight, and supersedes valid/invalid since the outcome is not yet known.
  • "faulted" is emitted when the field's last async validation threw a non-cancellation exception, and supersedes valid/invalid since the infrastructure failed to determine validity.
  • "valid" or "invalid" reflects whether any validation messages exist for the field once no pending or faulted state applies.
public:
 virtual System::String ^ GetFieldCssClass(Microsoft::AspNetCore::Components::Forms::EditContext ^ editContext, Microsoft::AspNetCore::Components::Forms::FieldIdentifier ^ fieldIdentifier);
public virtual string GetFieldCssClass(Microsoft.AspNetCore.Components.Forms.EditContext editContext, in Microsoft.AspNetCore.Components.Forms.FieldIdentifier fieldIdentifier);
abstract member GetFieldCssClass : Microsoft.AspNetCore.Components.Forms.EditContext * FieldIdentifier -> string
override this.GetFieldCssClass : Microsoft.AspNetCore.Components.Forms.EditContext * FieldIdentifier -> string
Public Overridable Function GetFieldCssClass (editContext As EditContext, fieldIdentifier As FieldIdentifier) As String

Parameters

editContext
EditContext

The EditContext.

fieldIdentifier
FieldIdentifier

The FieldIdentifier.

Returns

String

A CSS class name string.

Applies to