Table of Contents

Class FormComponentWithNestedComponents<TProperties, TClientProperties, TValue>

Namespace
Kentico.Xperience.Admin.Base.Forms
Assembly
Kentico.Xperience.Admin.Base.dll

Represents a form component that has a nested components within, i.e. form nested within.

public abstract class FormComponentWithNestedComponents<TProperties, TClientProperties, TValue> : FormComponent<TProperties, TClientProperties, TValue>, IFormComponent, IFormItem<IFormComponentClientProperties>, IFormItem where TProperties : FormComponentProperties, new() where TClientProperties : FormComponentClientProperties<TValue>, new()

Type Parameters

TProperties
TClientProperties
TValue
Inheritance
object
FormComponent<TProperties, TClientProperties, TValue>
FormComponentWithNestedComponents<TProperties, TClientProperties, TValue>
Implements
Derived
Inherited Members
Extension Methods

Constructors

FormComponentWithNestedComponents(IFormComponentCommandInvoker, IFormDataBinder)

Initializes a new instance of the FormComponentWithNestedComponents<TProperties, TClientProperties, TValue> class for the specified properties type.

public FormComponentWithNestedComponents(IFormComponentCommandInvoker formComponentCommandInvoker, IFormDataBinder formDataBinder)

Parameters

formComponentCommandInvoker IFormComponentCommandInvoker
formDataBinder IFormDataBinder

Properties

CommandContext

Form component command context.

protected FormComponentCommandContext CommandContext { get; }

Property Value

FormComponentCommandContext

Remarks

The context is set during the command processing and is available for the whole command processing.

FormComponentCommandInvoker

Component command invoker.

protected IFormComponentCommandInvoker FormComponentCommandInvoker { get; }

Property Value

IFormComponentCommandInvoker

FormDataBinder

Binder for form data.

protected IFormDataBinder FormDataBinder { get; }

Property Value

IFormDataBinder

Methods

ComponentCommand(FormComponentCommandModel, CancellationToken)

Processes the command of a nested form component.

public virtual Task<object> ComponentCommand(FormComponentCommandModel commandModel, CancellationToken cancellationToken)

Parameters

commandModel FormComponentCommandModel

The command model containing data necessary for the correct processing.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<object>

GetNestedFormItems()

Returns the form items that are used within the nested form.

protected abstract Task<ICollection<IFormItem>> GetNestedFormItems()

Returns

Task<ICollection<IFormItem>>

InitializeNestedContext()

Initializes form context within the nested form.

protected virtual Task<IFormContext> InitializeNestedContext()

Returns

Task<IFormContext>