Class FormComponentVisibilityEvaluator

Namespace

Kentico.Forms.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Evaluator of form component visibility conditions.

[Obsolete("This API is only available for legacy Form Builder components that provide backward compatibility when transitioning from older versions. The API will be removed when support for the Form Builder compatibility mode is dropped.")]
public class FormComponentVisibilityEvaluator : IFormComponentVisibilityEvaluator

Inheritance

object

FormComponentVisibilityEvaluator

Implements

IFormComponentVisibilityEvaluator

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

FormComponentVisibilityEvaluator()

public FormComponentVisibilityEvaluator()

Methods

IsComponentVisible(FormComponent, IEnumerable<FormComponent>, IEnumerable<FormComponent>)

Evaluates VisibilityCondition of given component. If the component depends on another fields, the visibility condition is evaluated against provided visibleComponents.

public bool IsComponentVisible(FormComponent component, IEnumerable<FormComponent> visibleComponents, IEnumerable<FormComponent> components)

Parameters

component FormComponent

Form component which visibility condition is evaluated.

visibleComponents IEnumerable<FormComponent>

Visible form components.

components IEnumerable<FormComponent>

Form components defined in the component properties class.

Returns

bool

true if the component is visible or visibility condition is null, otherwise false. false is also returned when visibility condition depends on another field which is not present in visibleComponents enumeration.

Exceptions

ArgumentNullException

Thrown when component or components or visibleComponents is null.