UniSelector Properties |
The UniSelector type exposes the following members.
Name | Description | |
---|---|---|
![]() | AddGlobalObjectNamePrefix |
Indicates whether global object names should be selected with prefix '.'
|
![]() | AddGlobalObjectSuffix |
Indicates whether global objects have suffix "(global)" in the grid.
|
![]() | AdditionalColumns |
Additional columns to select.
|
![]() | AdditionalSearchColumns |
Additional columns to search in.
|
![]() | AdditionalUrlParameters |
Additional URL parameters added to dialogs URLs.
Must start with '&'.
|
![]() | AllowAll |
Specifies, whether the selector allows selection of all items. If the dialog allows selection of all items,
it displays the (all) field in the DDL variant.
When property is selected then Uniselector doesn’t load any data from DB, it just returns -1 value
and external code must handle data loading.
|
![]() | AllowDefault |
Specifies, whether the selector allows default item selection. If the dialog allows default selection,
it displays the (default) field in the DDL variant (default false).
For multiple selection it returns empty string, otherwise it returns 0.
|
![]() | AllowEditTextBox |
If true, the textbox mode works with the return value and allows editing of the value.
|
![]() | AllowEmpty |
Specifies, whether the selector allows empty selection. If the dialog allows empty selection,
it displays the (none) field in the DDL variant and Clear button in the Textbox variant (default true).
For multiple selection it returns empty string, otherwise it returns 0.
|
![]() | AllowLocalizedFilteringInSelectionDialog |
Indicates whether localized filtering should be used in selection dialog.
|
![]() | AllRecordValue |
Value of the "(all)" DDL record, -1 by default.
|
![]() | ApplyValueRestrictions |
Gets or sets the value that indicates whether the UniSelector should apply WhereCondition for the selected value (default: true). This does not affect the modal dialog.
|
![]() | ButtonAddItems |
Gets the Add items button control.
|
![]() | ButtonClear |
Gets the Clear button control.
|
![]() | ButtonDropDownEdit |
Drop down list selection edit button.
|
![]() | ButtonDropDownNew |
New item button.
|
![]() | ButtonEdit |
Textbox selection edit button.
|
![]() | ButtonEditEnabled |
Sets a value indicating whether the Edit button should be enabled.
|
![]() | ButtonNewEnabled |
Sets a value indicating whether the New button should be enabled.
|
![]() | ButtonRemoveEnabled |
Sets a value indicating whether the Remove button should be enabled.
|
![]() | ButtonRemoveSelected |
Gets the Remove selected items button.
|
![]() | ButtonSelect |
Gets the Select button control.
|
![]() | CallbackMethod |
Callback java-script method name.
|
![]() | ComponentName |
Component name
(Inherited from AbstractUserControl.) |
![]() | ContextResolver |
Gets or sets macro resolver for given control.
(Inherited from FormEngineUserControl.) |
![]() | ControlStyle |
CSS style of the control.
(Inherited from FormEngineUserControl.) |
![]() | CssClass |
CSS class of the control.
(Inherited from FormEngineUserControl.) |
![]() | CurrentDocument |
Current document
(Inherited from AbstractUserControl.) |
![]() | CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) |
![]() | CurrentSite |
Current site
(Inherited from AbstractUserControl.) |
![]() | CurrentUser |
Current user
(Inherited from AbstractUserControl.) |
![]() | Data |
Node data. This property is used only for passing values to the control.
(Inherited from FormEngineUserControl.) |
![]() | DefaultDisplayNameFormat |
Default format of the display name. This format is used if the DisplayNameFormat (after resolving macros) is empty.
|
![]() ![]() | DefaultItemsPerPage |
Gets or sets the default value for the items per page.
|
![]() ![]() | DefaultMaxDisplayedItems |
Gets or sets the default value for maximum of displayed items in the selector.
|
![]() ![]() | DefaultMaxDisplayedTotalItems |
Gets or sets the default value for maximum of displayed total items in the selector. Default is 50. If exceeded, only MaxDisplayedItems is displayed.
|
![]() | DefaultProperties |
Control properties
(Inherited from FormEngineUserControl.) |
![]() | DependsOnAnotherField |
Indicates if field depends on another field.
(Inherited from FormEngineUserControl.) |
![]() | DialogButton |
Button selection control.
|
![]() | DialogGridName |
Dialog grid name (path to the XML).
|
![]() | DialogWindowHeight |
Dialog window height.
|
![]() | DialogWindowName |
Dialog window name.
|
![]() | DialogWindowWidth |
Dialog window width.
|
![]() | DisabledAddButtonExplanationText |
Gets or sets explanation text if button for adding new items is disabled in Multiple mode.
|
![]() | DisabledItems |
Gets or sets identifiers of disabled items for selection dialog in multiple choice mode. Identifiers are separated by semicolon.
|
![]() | DisplayNameFormat |
Format of the display name.
|
![]() | DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) |
![]() | DropDownItems |
List of items of drop down control
|
![]() | DropDownSingleSelect |
Gets the single select drop down field.
|
![]() | DynamicColumnName |
If true first column is dynamically named by object type info.
|
![]() | EditDialogWindowHeight |
Gets or sets the height of modal dialog window used for editing.
|
![]() | EditDialogWindowWidth |
Gets or sets the width of modal dialog window used for editing.
|
![]() | EditedObject |
Control's edited object
(Inherited from FormEngineUserControl.) |
![]() | EditItemElementName |
Gets or sets the UI element which defines the Edit item dialog page. Requires the ResourceName property to be defined.
|
![]() | EditItemPageUrl |
Path to the edit item page.
|
![]() | EditWindowName |
Name of the edit window.
|
![]() | ElementResourceName |
Gets or sets the resource name of the new/edit pages when defined by UI element names. Resource name determines the module which the UI elements belong to.
|
![]() | EmptyReplacement |
Replaces items which don't have any visible text to be displayed. Default is empty string.
|
![]() | Enabled |
Gets or sets the enabled state of the control.
(Overrides FormEngineUserControlEnabled.) |
![]() | EnabledColumnName |
Column name where the enabled flag of the object is stored.
|
![]() | EncodeOutput |
If true, the output is encoded. Applied in SingleTransformation mode. Default value is true.
|
![]() | ErrorMessage |
Control custom error message.
(Inherited from FormEngineUserControl.) |
![]() | Field |
Field name to which the field belongs.
(Inherited from FormEngineUserControl.) |
![]() | FieldInfo |
Field info object.
(Inherited from FormEngineUserControl.) |
![]() | FilterControl |
Path to the filter control (CMSAbstractBaseFilterControl), which will be used for advanced filtering of
the objects in the selection dialogs.
|
![]() | FilteredZeroRowsText |
Filtered zero rows text.
So far works only for the selection dialog.
Use only if you need special text that cannot be only retrieved from the resource strings.
Otherwise use ResourcePrefix property and create "ResourcePrefix.noitemsfound" resource string.
This property has higher priority than the resource string.
|
![]() | Form |
Parent form.
(Inherited from FormEngineUserControl.) |
![]() | FormControlParameter |
Helper property to use custom parameter in form control.
(Inherited from FormEngineUserControl.) |
![]() | GlobalObjectSuffix |
Gets or set the suffix which is added to global objects if AddGlobalObjectSuffix is true. Default is "(global)".
|
![]() | GridName |
Grid name (path to the XML) for the multiple selection grid.
|
![]() | HasData |
Gets the value that indicates whether current selector in multiple mode displays some data or whether the dropdown contains some data.
|
![]() | HasDependingFields |
Indicates if another fields depend on this field.
(Inherited from FormEngineUserControl.) |
![]() | HasValue |
Indicates if UniSelector value was set.
|
![]() | HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) |
![]() | CheckFieldEmptiness |
Indicates that field should be checked on emptiness in validation step by BasicForm. Default TRUE.
It is preferable to set to FALSE for controls with complex input such as file uploaders. Field emptiness
validation then must be placed in custom form control in IsValid() method.
(Inherited from FormEngineUserControl.) |
![]() | CheckChanges |
Indicates whether to call check changes script before selecting some value
|
![]() | CheckMinMaxLength |
Indicates that field should be checked on min/max input length in validation step by BasicForm. Default FALSE.
It is preferable to set to TRUE for simple text input controls such as TextBox.
(Inherited from FormEngineUserControl.) |
![]() | CheckRegularExpression |
Indicates that field should be checked on regular expressions in validation step by BasicForm. Default FALSE.
It is preferable to set to TRUE for controls where user should be able to enter text such as TextBox.
(Inherited from FormEngineUserControl.) |
![]() | CheckUnique |
If true, the field is checked for uniqueness. This property is only supported in templated form.
(Inherited from FormEngineUserControl.) |
![]() | Identifier |
Dialog control identifier.
|
![]() | InputClientID |
Client ID of primary input control. If not explicitly set, first client ID of inner control of the form control is returned.
(Inherited from FormEngineUserControl.) |
![]() | InputControlID |
Control ID of primary input control. If not explicitly set, first control ID of inner control of the form control is returned.
(Inherited from FormEngineUserControl.) |
![]() | IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) |
![]() | IsSiteManager |
If true, uni-selector is used in site manager.
|
![]() | Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) |
![]() | ItemsPerPage |
Default number of items per page. Applies to all Base multiple selection grid,
dropdownlist, single and multiple selection dialogs. Default 25.
|
![]() | ListingObject |
Type of alternative info object used in multiple picker grid view.
|
![]() | ListingObjectType |
Name of alternative grid view listing object type.
|
![]() | ListingWhereCondition |
Where condition of alternative grid view listing.
|
![]() | LocalizeItems |
Specifies whether the selector should resolve localization macros.
|
![]() | MaxDisplayedItems |
The number of maximum displayed items in the dropdownlist selection (excluding the special and generic items). Default is 25.
|
![]() | MaxDisplayedTotalItems |
The number of maximum displayed total items in the dropdownlist selection (excluding the special and generic items). Default is 50. If exceeded, only MaxDisplayedItems is displayed.
|
![]() | MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) |
![]() | NewItemElementName |
Gets or sets the UI element which defines the New item dialog page. Requires the ResourceName property to be defined.
|
![]() | NewItemPageUrl |
Path to the new item page.
|
![]() | NoDataTransformation |
Transformation used in case no object was selected. Applied in SingleTransformation mode.
|
![]() | NoneRecordValue |
Value of the "(none)" DDL record, 0 by default.
|
![]() | Object |
Object of the specific given type.
|
![]() | ObjectSiteName |
Gets or sets site name. If set, only objects which belong to specified site are retrieved (if the object has SiteID column). If null or empty, all objects are retrieved.
Use #currentsite or #current for CurrentSite and #global for global objects or #currentandglobal for both.
|
![]() | ObjectTransformation |
Object transformation used in SingleTransformation selection mode.
|
![]() | ObjectType |
Type of the selected objects.
|
![]() | OnAfterClientChanged |
Client java-script code after event 'onchange'.
|
![]() | OnBeforeClientChanged |
Client java-script code before event 'onchange'.
|
![]() | OnlySpecialFields |
Indicates if only special fields should be displayed.
|
![]() | OrderBy |
Base order of the items. Applies to all Base multiple selection grid,
dropdownlist, single and multiple selection dialogs.
|
![]() | Parameter |
Control parameter.
(Inherited from InlineUserControl.) |
![]() | PriorityCSSClass |
Priority CSS class for items where PriorityWhereCondition is applied.
|
![]() | PriorityWhereCondition |
Where condition for items with high priority.
|
![]() | Properties |
Control properties.
(Inherited from InlineUserControl.) |
![]() | RememberOriginalValue |
If true, the control remembers the original value for evaluation
(Inherited from FormEngineUserControl.) |
![]() | RemoveConfirmation |
Confirmation message for the items removal. To disable confirmation, set this property to an empty string.
|
![]() | RemoveMultipleCommas |
Indicates whether to remove multiple commas (can happen when DisplayNameFormat is like {%column1%}, {%column2%}, {column3} and column2 is empty.
|
![]() | ResolverName |
Gets or sets macro resolver name.
(Inherited from FormEngineUserControl.) |
![]() | ResourcePrefix |
Prefix for the resource strings which will be used for the strings of the selector.
Default is "General".
(Overrides FormEngineUserControlResourcePrefix.) |
![]() | ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) |
![]() | ReturnColumnName |
Column name of the object which value should be returned by the selector.
If NULL, ID column is used.
|
![]() | ReturnColumnType |
Gets or sets the type of the column which will be used as a return value when the new/edit item dialog is saved.
|
![]() | ScriptSafeValueSeparator |
ValueSeparator encoded for JavaScript and encapsulated into "'".
|
![]() | SelectionConfirmation |
Confirmation message for the items selection.
|
![]() | SelectionMode |
Indicates selection mode of the control.
This property should not be changed later than on Page Init as it causes invalid hash.
If you need to change it later than on Page Init, use reload method after changing this.
|
![]() | SelectItemPageUrl |
URL of select item dialog.
|
![]() | ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) |
![]() | SortExpression |
Gets or sets sort expression of the unigrid in Multiple mode.
|
![]() | SpecialFields |
Array with the special field values that should be added to the DropDownList selection,
between the (none) item and the other items.
|
![]() | StopProcessing |
If true, control does not process the data.
(Inherited from FormEngineUserControl.) |
![]() | Text |
Gets or sets Value converted to string.
(Inherited from FormEngineUserControl.) |
![]() | TextBoxSelect |
TextBox control.
|
![]() | Transformation |
Transformation used for output formating. Applied in SingleTransformation mode. If empty, the object display name is returned.
|
![]() | Trim |
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
(Inherited from FormEngineUserControl.) |
![]() | UIContext |
Control's UI Context
(Inherited from FormEngineUserControl.) |
![]() | UnderlyingFormControl |
Underlying form control, if provided, the form control automatically redirects all properties to that control
(Inherited from FormEngineUserControl.) |
![]() | UniGrid |
Multiple selection grid.
|
![]() | UseDefaultNameFilter |
If true, name filter is used (default true), it can be disabled when some FilterControl is used.
|
![]() | UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) |
![]() | UseTypeCondition |
If true, the selector uses the type condition to get the data
|
![]() | UseUniSelectorAutocomplete |
Internal purposes only, do not use.
|
![]() | ValidationError |
Validation error string shown when the control is not valid.
(Inherited from FormEngineUserControl.) |
![]() | Value |
Gets or sets field value. You need to override this method to make the control work properly with the form.
(Inherited from FormEngineUserControl.) |
![]() | ValueDisplayName |
Gets the display name of the value item. Returns null if display name is not available.
(Inherited from FormEngineUserControl.) |
![]() | ValueElementID |
Gets ClientID of the control from which the Value is retrieved or
null if such a control can't be specified.
(Inherited from FormEngineUserControl.) |
![]() | ValueForValidation |
Returns value prepared for validation.
(Inherited from FormEngineUserControl.) |
![]() | ValuesSeparator |
If there is a multi-selection enabled, the returned values are separated by this separator.
Default is semicolon ";".
|
![]() | ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) |
![]() | WhereCondition |
Base where condition for the objects selection. Applies to all Base multiple selection grid,
dropdownlist, single and multiple selection dialogs.
|
![]() | WhereConditionFormat |
Format of where condition.
(Inherited from FormEngineUserControl.) |
![]() | ZeroRowsText |
Zero rows text.
Use only if you need special text that cannot be only retrieved from the resource strings.
Otherwise use ResourcePrefix property and create "ResourcePrefix.nodatafound" resource string.
This property has higher priority than the resource string.
|