Class FormComponentMetadata

Namespace

Kentico.Forms.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Metadata describing a form component for the client.

public class FormComponentMetadata

Inheritance

object

FormComponentMetadata

Derived

FormFeaturedFieldMetadata

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Properties

DefaultPropertiesUrl

URL of an endpoint for retrieving default properties of a form component.

[JsonProperty("defaultPropertiesUrl")]
public string DefaultPropertiesUrl { get; }

Property Value

string

Description

Form component description.

[JsonProperty("description")]
public string Description { get; }

Property Value

string

IconClass

Form component icon CSS class.

[JsonProperty("iconClass")]
public string IconClass { get; }

Property Value

string

Identifier

Form component identifier.

[JsonProperty("identifier")]
public string Identifier { get; }

Property Value

string

IsFeaturedField

Indicates whether the metadata represents featured fields.

[JsonProperty("isFeaturedField")]
public bool IsFeaturedField { get; set; }

Property Value

bool

MarkupUrl

URL of an endpoint for retrieving markup of a rendered form component.

[JsonProperty("markupUrl")]
public string MarkupUrl { get; }

Property Value

string

Name

Form component name.

[JsonProperty("name")]
public string Name { get; }

Property Value

string

UseAdminFormComponents

Indicates whether the form component properties form should be opened from the administration UI using admin form components or from the page builder using MVC form components.

[JsonProperty("useAdminFormComponents")]
public bool UseAdminFormComponents { get; set; }

Property Value

bool

ValueType

Type of the resulting component value, used to find appropriate validation rules.

[JsonProperty("valueType")]
public string ValueType { get; }

Property Value

string

Remarks

Full name of type normalized to lower case is expected.