ObjectSelectorProperties Class

Represents properties of the ObjectSelector.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponentProperties
    Kentico.Forms.Web.Mvc.FormComponentProperties<IEnumerable<ObjectSelectorItem>>
      Kentico.Components.Web.Mvc.Selectors.ObjectSelectorPropertiesBase<ObjectSelectorItem>
        Kentico.Components.Web.Mvc.FormComponents.ObjectSelectorProperties

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

Syntax

public class ObjectSelectorProperties : ObjectSelectorPropertiesBase<ObjectSelectorItem>

The ObjectSelectorProperties type exposes the following members.

Constructors

	Name	Description
Public method	ObjectSelectorProperties

Properties

	Name	Description
Public property	DataType	Gets or sets the underlying field data type. (Inherited from FormComponentProperties.)
Public property	DefaultValue	When overridden in a derived class, gets or sets the default value of the form component and underlying field. Use the DefaultValueEditingComponentAttribute to specify a form component for editing. (Inherited from ObjectSelectorPropertiesBase<TItem>.)
Public property	ExplanationText	Gets or sets the explanation text of the form component. (Inherited from FormComponentProperties.)
Public property	Guid	Gets or sets the underlying field GUID. (Inherited from FormComponentProperties.)
Public property	IdentifyObjectByGuid	Indicates whether the Object selector uses the object's GUID column value to identify the object. If set to false the object's code name column value is used. Defaults to false. It's recommended to have it set to false, ie. identify objects by their code names if a performance is a concern. The reason is that most system object types incorporate provider-level cache by the object's code name, not its GUID.
Public property	IncludeGlobalObjects	Indicates whether global objects should be also returned in case when the ObjectType may exist in both site and global form.
Public property	Label	Gets or sets the label of the form component. (Inherited from FormComponentProperties.)
Public property	MaxItemsLimit	Configures the maximum number of items allowed to be selected. 0 - unlimited items; N - at most N items. Default value is 1. (Inherited from ObjectSelectorPropertiesBase<TItem>.)
Public property	Name	Gets or sets the underlying field name. (Inherited from FormComponentProperties.)
Public property	ObjectType	Defines which objects will be displayed in the selector.
Public property	OrderBy	Defines a list of columns which the data should be sorted by, e.g. ["NodeLevel", "DocumentName DESC"]
Public property	Placeholder	Gets or sets the value displayed as placeholder in the input. Override and annotate with EditingComponentAttribute to make this property editable in properties panel. (Inherited from FormComponentProperties.)
Public property	Precision	Gets or sets the underlying field precision. (Inherited from FormComponentProperties.)
Public property	Required	Gets or sets value indicating whether the underlying field is required. False by default. If false, the form component's implementation must accept nullable input. (Inherited from FormComponentProperties.)
Public property	Size	Gets or sets the underlying field size. (Inherited from FormComponentProperties.)
Public property	SmartField	Gets or sets value indicating whether the underlying field is smart field. False by default. (Inherited from FormComponentProperties.)
Public property	Tooltip	Gets or sets the tooltip of the form component. (Inherited from FormComponentProperties.)
Public property	ValidationRuleConfigurations	Gets or sets validation rule configurations assigned to the form component. (Inherited from FormComponentProperties.)
Public property	VisibilityConditionConfiguration	Gets or sets visibility condition configuration assigned to the form component. (Inherited from FormComponentProperties.)
Public property	WhereConditionProviderType	Defines the type which provides the WhereCondition that will be applied to the database query. The where condition provider type must implement the IObjectSelectorWhereConditionProvider interface.

Methods

	Name	Description
Public method	GetDefaultValue	Gets the default value. The DefaultValue property can be used directly to obtain the typed default value. (Inherited from FormComponentProperties<TValue>.)
Public method	SetDefaultValue	Sets the default value to value. The value must be of type TValue or an exception is thrown. The DefaultValue property can be used directly to set the typed default value. (Inherited from FormComponentProperties<TValue>.)