Table of Contents

Class FormComponentConfigurationAttribute

Namespace
Kentico.Xperience.Admin.Base.FormAnnotations
Assembly
Kentico.Xperience.Admin.Base.Shared.dll

Allows to configure a form component instance, specified by the FormComponentAttribute.

[AttributeUsage(AttributeTargets.Property, AllowMultiple = false, Inherited = false)]
public class FormComponentConfigurationAttribute : Attribute
Inheritance
object
Attribute
FormComponentConfigurationAttribute
Extension Methods

Remarks

The configurator is invoked when all form components properties are set.

Constructors

FormComponentConfigurationAttribute(string)

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(string identifier)

Parameters

identifier string

The form component configurator identifier.

FormComponentConfigurationAttribute(string, string)

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(string identifier, string dependencyFieldName)

Parameters

identifier string

The form component configurator identifier.

dependencyFieldName string

Name of the dependency field which will trigger the configurator when changed.

FormComponentConfigurationAttribute(string, string[])

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(string identifier, string[] dependencyFieldNames)

Parameters

identifier string

The form component configurator identifier.

dependencyFieldNames string[]

Names of the dependency fields which will trigger the configurator when changed.

FormComponentConfigurationAttribute(Type)

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(Type configuratorType)

Parameters

configuratorType Type

The form component configurator type. The configurator type must inherit from the Kentico.Xperience.Admin.Base.Forms.FormComponentConfigurator class.

FormComponentConfigurationAttribute(Type, string)

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(Type configuratorType, string dependencyFieldName)

Parameters

configuratorType Type

The form component configurator type. The configurator type must inherit from the Kentico.Xperience.Admin.Base.Forms.FormComponentConfigurator class.

dependencyFieldName string

Name of the dependency field which will trigger the configurator when changed.

FormComponentConfigurationAttribute(Type, string[])

Initializes a new instance of the FormComponentConfigurationAttribute class.

public FormComponentConfigurationAttribute(Type configuratorType, string[] dependencyFieldNames)

Parameters

configuratorType Type

The form component configurator type. The configurator type must inherit from the Kentico.Xperience.Admin.Base.Forms.FormComponentConfigurator class.

dependencyFieldNames string[]

Names of the dependency fields which will trigger the configurator when changed.

Properties

ConfiguratorType

Form component configurator type. The configurator class must inherit from the Kentico.Xperience.Admin.Base.Forms.FormComponentConfigurator class.

public Type ConfiguratorType { get; }

Property Value

Type

DependencyFieldName

Name of the dependency field which will trigger the configurator when changed.

[Obsolete("Use DependencyFieldNames instead.")]
[ObsoleteSince(28, 4)]
public string DependencyFieldName { get; }

Property Value

string

DependencyFieldNames

Names of the dependency fields which will trigger the configurator when changed.

public IEnumerable<string> DependencyFieldNames { get; }

Property Value

IEnumerable<string>

Identifier

Form component configurator identifier.

public string Identifier { get; }

Property Value

string