Click or drag to resize
ObjectSelectorProperties Class
Represents properties of the ObjectSelector.
Inheritance Hierarchy
SystemObject
  Kentico.Forms.Web.MvcFormComponentProperties
    Kentico.Forms.Web.MvcFormComponentPropertiesIEnumerableObjectSelectorItem
      Kentico.Components.Web.Mvc.SelectorsObjectSelectorPropertiesBaseObjectSelectorItem
        Kentico.Components.Web.Mvc.FormComponentsObjectSelectorProperties

Namespace: Kentico.Components.Web.Mvc.FormComponents
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 13.0.131
Syntax
C#
public class ObjectSelectorProperties : ObjectSelectorPropertiesBase<ObjectSelectorItem>

The ObjectSelectorProperties type exposes the following members.

Constructors
  NameDescription
Public methodObjectSelectorProperties
Top
Properties
  NameDescription
Public propertyDataType
Gets or sets the underlying field data type.
(Inherited from FormComponentProperties.)
Public propertyDefaultValue
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 ObjectSelectorPropertiesBaseTItem.)
Public propertyExplanationText
Gets or sets the explanation text of the form component.
(Inherited from FormComponentProperties.)
Public propertyGuid
Gets or sets the underlying field GUID.
(Inherited from FormComponentProperties.)
Public propertyIdentifyObjectByGuid
Indicates whether the Object selector uses the object's GUID column value to identify the object. If set to the object's code name column value is used. Defaults to .

It's recommended to have it set to , 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 propertyIncludeGlobalObjects
Indicates whether global objects should be also returned in case when the ObjectType may exist in both site and global form.
Public propertyLabel
Gets or sets the label of the form component.
(Inherited from FormComponentProperties.)
Public propertyMaxItemsLimit
Configures the maximum number of items allowed to be selected.
  • 0 - unlimited items;
  • N - at most N items.
Default value is 1.
(Inherited from ObjectSelectorPropertiesBaseTItem.)
Public propertyName
Gets or sets the underlying field name.
(Inherited from FormComponentProperties.)
Public propertyObjectType
Defines which objects will be displayed in the selector.
Public propertyOrderBy
Defines a list of columns which the data should be sorted by, e.g. ["NodeLevel", "DocumentName DESC"]
Public propertyPlaceholder
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 propertyPrecision
Gets or sets the underlying field precision.
(Inherited from FormComponentProperties.)
Public propertyRequired
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 propertySize
Gets or sets the underlying field size.
(Inherited from FormComponentProperties.)
Public propertySmartField
Gets or sets value indicating whether the underlying field is smart field. False by default.
(Inherited from FormComponentProperties.)
Public propertyTooltip
Gets or sets the tooltip of the form component.
(Inherited from FormComponentProperties.)
Public propertyValidationRuleConfigurations
Gets or sets validation rule configurations assigned to the form component.
(Inherited from FormComponentProperties.)
Public propertyVisibilityConditionConfiguration
Gets or sets visibility condition configuration assigned to the form component.
(Inherited from FormComponentProperties.)
Public propertyWhereConditionProviderType
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.

Top
Methods
  NameDescription
Public methodGetDefaultValue
Gets the default value. The DefaultValue property can be used directly to obtain the typed default value.
(Inherited from FormComponentPropertiesTValue.)
Public methodSetDefaultValue
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 FormComponentPropertiesTValue.)
Top
See Also