Class FormCategory

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Represents a form category.

public class FormCategory : IFormItem<IFormCategoryClientProperties>, IFormItem

Inheritance

object

FormCategory

Implements

IFormItem<IFormCategoryClientProperties>

IFormItem

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

FormItemExtensions.IsValid(IFormItem)

FormItemExtensions.IsVisible(IFormItem)

Constructors

FormCategory()

Initializes a new instance of the FormCategory class.

public FormCategory()

Properties

Collapsible

Gets or sets whether the form category is collapsible.

public bool? Collapsible { get; set; }

Property Value

bool?

ComponentName

Determine which component should be used on frontend.

public string ComponentName { get; set; }

Property Value

string

IsCollapsed

Gets or sets whether the form category is collapsed on first render.

public bool? IsCollapsed { get; set; }

Property Value

bool?

Order

Gets or sets the form category order weight in the form.

public int Order { get; set; }

Property Value

int

Remarks

The order is shared with FormComponentAttribute individual form components in the model.

Title

Gets or sets the form category title.

public string Title { get; set; }

Property Value

string

Remarks

Localized string can be used.

Tooltip

Gets or sets the tooltip of the form component.

public string Tooltip { get; set; }

Property Value

string

Remarks

Localized string can be used.

Methods

GetClientProperties()

Returns form category client properties.

public Task<IFormCategoryClientProperties> GetClientProperties()

Returns

Task<IFormCategoryClientProperties>