Table of Contents

Class EditingComponentAttribute

Namespace
Kentico.Forms.Web.Mvc
Assembly
Kentico.Content.Web.Mvc.dll

Denotes a property that can be edited using the specified form component. Use the optional properties of the attribute to configure the basic properties of the form component assigned or use EditingComponentPropertyAttribute to further configure the form component.

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

Constructors

EditingComponentAttribute(string)

Initializes a new instance of the EditingComponentAttribute class.

public EditingComponentAttribute(string formComponentIdentifier)

Parameters

formComponentIdentifier string

Defines identifier of a FormComponent<TProperties, TValue> registered via RegisterFormComponentAttribute which is used for editing the annotated property from Form builder's UI.

Exceptions

ArgumentException

Thrown when formComponentIdentifier is null or an empty string.

Properties

DefaultValue

Gets or sets the default value of the form component.

public object DefaultValue { get; set; }

Property Value

object
See Also

ExplanationText

Gets or sets the explanation text of the form component.

public string ExplanationText { get; set; }

Property Value

string
See Also

FormComponentIdentifier

Identifier of the form component to be used for editing.

public string FormComponentIdentifier { get; }

Property Value

string

Remarks

The identifier defines a FormComponent<TProperties, TValue> registered via RegisterFormComponentAttribute.

See Also

Label

Gets or sets the label of the form component.

public string Label { get; set; }

Property Value

string
See Also

Order

Gets or sets the order weight of the form component.

public int Order { get; set; }

Property Value

int
See Also

Tooltip

Gets or sets the tooltip of the form component.

public string Tooltip { get; set; }

Property Value

string
See Also

See Also

EditingComponentPropertyAttribute
EditingComponentOrder