Class

TelerikForm

Declaration

public TelerikForm()

Defines the autocomplete attribute of the form.

Declaration

[Parameter]
public string AutoComplete { get; set; }

Property Value

Defines the different buttons layout for horizontal alignment. Default value is End for horizontal, and Start for vertical.

Declaration

[Parameter]
public FormButtonsLayout? ButtonsLayout { get; set; }

Property Value

Defines the spacing between columns in form grid layout.

Declaration

[Parameter]
public string ColumnSpacing { get; set; }

Property Value

Defines the count of columns in form grid layout.

Declaration

[Parameter]
public int Columns { get; set; }

Property Value

Defines the EditContext of the form. The user should specify either EditContext, or Model.

Declaration

[Parameter]
public EditContext EditContext { get; set; }

Property Value

Defines the template for the form buttons. By default, the form renders a Submit button.

Declaration

[Parameter]
public RenderFragment FormButtons { get; set; }

Property Value

Defines the form items.

Declaration

[Parameter]
public RenderFragment FormItems { get; set; }

Property Value

Defines the form items template. In this tempalte you can use TelerikFormItemRenderer and TelerikFormGroupRenderer tags and customize the form layout. The context of the template is a FormItemsTemplateContext which contains a list of IFormItemBase items. The items can be of type IFormItem or IFormGroup and they persist the same structure and order as they are defined in FormItems RenderFragment parameter.

Declaration

[Parameter]
public RenderFragment<FormItemsTemplateContext> FormItemsTemplate { get; set; }

Property Value

Defines the form validation. Should be used for declaring validator, validation summary. Renders before the FormItems and FormButtons.

Declaration

[Parameter]
public RenderFragment FormValidation { get; set; }

Property Value

Defines the id attribute of the form.

Declaration

[Parameter]
public string Id { get; set; }

Property Value

Defines the model of the form. If no FormItems are added, it will automatically generate fields for the user. The user should specify either Model, or EditContext.

Declaration

[Parameter]
public object Model { get; set; }

Property Value

Fires when the form is submitted with invalid EditContext.

Declaration

[Parameter]
public EventCallback<EditContext> OnInvalidSubmit { get; set; }

Property Value

Fires when the form is submitted. Use this event for manually triggering validation. Cannot be used together with OnValidSubmit and OnInvalidSubmit.

Declaration

[Parameter]
public EventCallback<EditContext> OnSubmit { get; set; }

Property Value

Event triggered upon editing a field in the Telerik Form. The changed field name and newly updated model are available through the FormUpdateEventArgs event context.

Declaration

[Parameter]
public EventCallback<FormUpdateEventArgs> OnUpdate { get; set; }

Property Value

Fires when the form is submitted with valid EditContext.

Declaration

[Parameter]
public EventCallback<EditContext> OnValidSubmit { get; set; }

Property Value

Defines the orientation of the form in terms of label and form editor position. Default value is Vertical.

Declaration

[Parameter]
public FormOrientation Orientation { get; set; }

Property Value

Specifies the Size of the form. Default value is Medium.

Declaration

[Parameter]
public string Size { get; set; }

Property Value

Defines the way the validation errors should be displayed. Default value is Inline.

Declaration

[Parameter]
public FormValidationMessageType ValidationMessageType { get; set; }

Property Value

Defines the width of the form.

Declaration

[Parameter]
public string Width { get; set; }

Property Value

Declaration

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Validates the form and checks whether is valid or not.

Declaration

public bool IsValid()

Returns

Declaration

protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()

Re-renders the component.

Declaration

public void Refresh()

Declaration

public override Task SetParametersAsync(ParameterView parameters)

Parameters

Returns

Overrides ComponentBase.SetParametersAsync(ParameterView)