EditForm Class

Definition

Namespace:

Microsoft.AspNetCore.Components.Forms

Assembly:

Microsoft.AspNetCore.Components.Web.dll

Package:

Microsoft.AspNetCore.Components.Web v8.0.0

Source:

EditForm.cs

Renders a form element that cascades an EditContext to descendants.

public ref class EditForm : Microsoft::AspNetCore::Components::ComponentBase

public class EditForm : Microsoft.AspNetCore.Components.ComponentBase

type EditForm = class
    inherit ComponentBase

Public Class EditForm
Inherits ComponentBase

Inheritance

Object

ComponentBase

EditForm

Constructors

EditForm()

Constructs an instance of EditForm.

Properties

AdditionalAttributes	Gets or sets a collection of additional attributes that will be applied to the created form element.
Assets	Gets the ResourceAssetCollection for the application. (Inherited from ComponentBase)
AssignedRenderMode	Gets the IComponentRenderMode assigned to this component. (Inherited from ComponentBase)
ChildContent	Specifies the content to be rendered inside this EditForm.
EditContext	Supplies the edit context explicitly. If using this parameter, do not also supply Model, since the model value will be taken from the Model property.
Enhance	If enabled, form submission is performed without fully reloading the page. This is equivalent to adding data-enhance to the form. This flag is only relevant in server-side rendering (SSR) scenarios. For interactive rendering, the flag has no effect since there is no full-page reload on submit anyway.
FormName	Gets or sets the form handler name. This is required for posting it to a server-side endpoint. It is not used during interactive rendering.
Model	Specifies the top-level model object for the form. An edit context will be constructed for this model. If using this parameter, do not also supply a value for EditContext.
OnInvalidSubmit	A callback that will be invoked when the form is submitted and the EditContext is determined to be invalid.
OnSubmit	A callback that will be invoked when the form is submitted. If using this parameter, you are responsible for triggering any validation manually, e.g., by calling Validate().
OnValidSubmit	A callback that will be invoked when the form is submitted and the EditContext is determined to be valid.
RendererInfo	Gets the RendererInfo the component is running on. (Inherited from ComponentBase)

Methods

BuildRenderTree(RenderTreeBuilder)	Renders the component to the supplied RenderTreeBuilder.
DispatchExceptionAsync(Exception)	Treats the supplied exception as being thrown by this component. This will cause the enclosing ErrorBoundary to transition into a failed state. If there is no enclosing ErrorBoundary, it will be regarded as an exception from the enclosing renderer. This is useful if an exception occurs outside the component lifecycle methods, but you wish to treat it the same as an exception from a component lifecycle method. (Inherited from ComponentBase)
InvokeAsync(Action)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
InvokeAsync(Func<Task>)	Executes the supplied work item on the associated renderer's synchronization context. (Inherited from ComponentBase)
OnAfterRender(Boolean)	Method invoked after each time the component has rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs. This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated. (Inherited from ComponentBase)
OnAfterRenderAsync(Boolean)	Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs. This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated. Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop. (Inherited from ComponentBase)
OnInitialized()	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. (Inherited from ComponentBase)
OnInitializedAsync()	Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed. (Inherited from ComponentBase)
OnParametersSet()	Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.
OnParametersSetAsync()	Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties. (Inherited from ComponentBase)
SetParametersAsync(ParameterView)	Sets parameters supplied by the component's parent in the render tree. (Inherited from ComponentBase)
ShouldRender()	Returns a flag to indicate whether the component should render. (Inherited from ComponentBase)
StateHasChanged()	Notifies the component that its state has changed. When applicable, this will cause the component to be re-rendered. (Inherited from ComponentBase)

Explicit Interface Implementations

IComponent.Attach(RenderHandle)	(Inherited from ComponentBase)
IHandleAfterRender.OnAfterRenderAsync()	(Inherited from ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object)	(Inherited from ComponentBase)