Interface IVisibilityCondition

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a visibility condition.

public interface IVisibilityCondition

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Remarks

The system uses this interface to process visibility conditions. For defining custom visibility conditions, inherit the VisibilityCondition class.

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.

IEnumerable<string> DependsOnFields { get; }

Property Value

IEnumerable<string>

IsVisible

Gets or sets the value indicating whether the visibility condition is met based on server-side evaluation.

bool IsVisible { get; set; }

Property Value

bool

Remarks

The system populates this property after visibility condition evaluation is triggered.

Methods

Evaluate(IFormFieldValueProvider)

Evaluates the visibility condition and returns the result.

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.

GetProperties()

Returns visibility condition configuration properties.

VisibilityConditionProperties GetProperties()

Returns

VisibilityConditionProperties

SetProperties(VisibilityConditionProperties)

Sets the visibility condition configuration properties.

void SetProperties(VisibilityConditionProperties properties)

Parameters

properties VisibilityConditionProperties

See Also

VisibilityCondition