FormComponentDefinition Class

Definition of a registered form component.

Inheritance Hierarchy

System.Object
  Kentico.Content.Web.Mvc.ComponentDefinitionBase
    Kentico.Forms.Web.Mvc.FormComponentDefinition

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0

Syntax

public class FormComponentDefinition : ComponentDefinitionBase, 
	IFormBuilderDefinition

The FormComponentDefinition type exposes the following members.

Constructors

	Name	Description
Public method	FormComponentDefinition	Initializes a new instance of the ComponentType class using given identifier, form component type and name.

Properties

	Name	Description
Public property	ComponentType	Gets the type of the form component. The type inherits FormComponent<TProperties, TValue>.
Public property	Description	Gets or sets the description of the form component.
Public property	FormComponentPropertiesType	Gets type of the form component's properties. The type inherits FormComponentProperties.
Public property	IconClass	Gets or sets icon CSS class of the form component.
Public property	Identifier	Unique identifier of the component definition. (Inherited from ComponentDefinitionBase.)
Public property	IsAvailableInFormBuilderEditor	Determines if the form component can be added via Form builder UI to a form. Set to false to allow the component to be used programmatically only. True by default.
Public property	Name	Name of the registered component. (Inherited from ComponentDefinitionBase.)
Public property	ValueType	Gets form component's value type.
Public property	ViewName	Gets or sets the name of the view to render.