Class VisibilityCondition<TProperties>

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a base class for visibility conditions.

public abstract class VisibilityCondition<TProperties> : IVisibilityCondition where TProperties : VisibilityConditionProperties, new()

Type Parameters

TProperties

Inheritance

object

VisibilityCondition<TProperties>

Implements

IVisibilityCondition

Derived

SettingsKeyVisibilityCondition

VisibilityCondition

VisibilityConditionWithDependency<TProperties>

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

VisibilityCondition()

Initializes a new instance of the VisibilityCondition<TProperties> class.

protected VisibilityCondition()

Properties

DependsOnFields

The list of fields the visibility condition evaluation depends on. Only dependencies on fields logically preceding the field this condition is associated with are supported.

public virtual IEnumerable<string> DependsOnFields { get; }

Property Value

IEnumerable<string>

Remarks

The implementation returns an empty enumeration. Override this member to return custom field names.

Properties

Contains values of configurable properties for the visibility condition.

public TProperties Properties { get; }

Property Value

TProperties

Remarks

Visibility conditions registered with RegisterFormVisibilityConditionAttribute attribute that property fields annotated with FormComponentAttribute attribute are editable in the Visibility condition section of the field editor.

Methods

Evaluate(IFormFieldValueProvider)

Evaluates the visibility condition and returns the result.

public abstract bool Evaluate(IFormFieldValueProvider formFieldValueProvider)

Parameters

formFieldValueProvider IFormFieldValueProvider

Provider of values of other form fields for contextual evaluation. Only fields logically preceding the current field are available.

Returns

bool

Returns true is the visibility condition is met (i.e. the associated component is to be displayed), otherwise returns false.