PageSelector Class

Represents a page selector form component.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<PageSelectorProperties, IEnumerable<PageSelectorItem>>
      Kentico.Components.Web.Mvc.FormComponents.Internal.PageSelectorBase<PageSelectorProperties, PageSelectorItem>
        Kentico.Components.Web.Mvc.FormComponents.PageSelector

Namespace: Kentico.Components.Web.Mvc.FormComponents
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131

Syntax

public class PageSelector : PageSelectorBase<PageSelectorProperties, PageSelectorItem>

The PageSelector type exposes the following members.

Constructors

	Name	Description
Public method	PageSelector

Fields

	Name	Description
Public field Static member	IDENTIFIER	Represents the PageSelector identifier.

Properties

	Name	Description
Public property	BaseProperties	Gets the form component's properties as its base type. (Inherited from FormComponent<TProperties, TValue>.)
Public property	CustomAutopostHandling	If true, prevents built-in visibility condition handling for this component. (Inherited from FormComponent.)
Public property	Definition	Gets or sets the definition under which the form component is registered in the system. (Inherited from FormComponent.)
Public property	HasDependingFields	Gets or sets a value indicating whether there are another form components whose visibility condition depends on this component's value. (Inherited from FormComponent.)
Public property	LabelForPropertyName	Gets the name of the property representing the editing field in the resulting HTML markup. The name is used to infer a proper label for attribute value in the rendered HTML markup. Defaults to first found property annotated with BindablePropertyAttribute. (Inherited from FormComponent.)
Public property	MaxPagesLimit	Gets the limit of maximum number of pages allowed to be selected. (Inherited from PageSelectorBase<TProperties, TValue>.)
Public property	Name	Gets or sets the name of the corresponding form field. The name is used as a prefix when naming the HTML input. (Inherited from FormComponent.)
Public property	Properties	Gets the form component's properties. (Inherited from FormComponent<TProperties, TValue>.)
Public property	PropertiesType	Gets the properties type of the form component. (Inherited from FormComponent.)
Public property	RootPath	Gets the dialog root path. (Inherited from PageSelectorBase<TProperties, TValue>.)
Public property	SelectedPageModel	Gets the serialized JSON model of the selected page(s). (Inherited from PageSelectorBase<TProperties, TValue>.)
Public property	ShowPartialValidationMessages	Also shows validation errors of partial values of the component. If false, each individual component should contain validation message in its partial view. (Inherited from FormComponent.)
Public property	Value	Represents the input value in the resulting HTML. (Inherited from PageSelectorBase<TProperties, TValue>.)

Methods

	Name	Description
Public method	BindContext	Binds contextual information to the form component. (Inherited from PageSelectorBase<TProperties, TValue>.)
Public method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Public method	GetModelPropertyCustomAttributes<T>	Gets a collection of custom attributes applied to the model's property this form component represents. (Inherited from FormComponent.)
Public method	GetObjectValue	Gets the value of the form component. The GetValue() method can be used directly to obtain the typed value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	GetValue	Gets the Value. (Inherited from PageSelectorBase<TProperties, TValue>.)
Public method	LoadProperties	Loads properties of the form component. The actual properties type must match the PropertiesType. (Inherited from FormComponent<TProperties, TValue>.)
Public method	ModifyMetadata	Modifies modelMetadata according to the current object. (Inherited from FormComponent.)
Public method	SetObjectValue	Sets the value of the form component. The value must be of proper type or an exception is thrown. The SetValue(TValue) method can be used directly to set the typed default value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	SetValue	Sets the Value. (Inherited from PageSelectorBase<TProperties, TValue>.)
Public method	Validate	Validates whether selected pages are valid. (Inherited from PageSelectorBase<TProperties, TValue>.)

Extension Methods

	Name	Description
Public Extension Method	GetBizFormComponentContext	Gets BizFormComponentContext of a form component, if such a context was bound to the component. (Defined by FormComponentExtensions.)