SiteSeparatedObjectSelector Class |
Namespace: CMS.Ecommerce.Web.UI
public abstract class SiteSeparatedObjectSelector : BaseObjectSelector
The SiteSeparatedObjectSelector type exposes the following members.
Name | Description | |
---|---|---|
SiteSeparatedObjectSelector |
Name | Description | |
---|---|---|
AddAllItemsRecord |
Gets or sets the value which determines, whether to add 'all' item record to the selector.
(Inherited from BaseObjectSelector.) | |
AdditionalItems |
ID of items which have to be displayed. Use ',' or ';' as separator if more IDs required.
(Inherited from BaseObjectSelector.) | |
AddNoneRecord |
Determines whether to add 'none' item record to the selector.
(Inherited from BaseObjectSelector.) | |
AllowCombineSiteAndGlobal |
Indicates if objects can be combined site and global within one site.
False means that site can use only global or only site records.
(Inherited from BaseObjectSelector.) | |
AllowCreate |
Indicates whether new button will be visible and creating of new object allowed.
(Inherited from BaseObjectSelector.) | |
AutoPostBack |
Determines whether the AutoPostBack property of dropdown list should be enabled.
(Inherited from BaseObjectSelector.) | |
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.) | |
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.) | |
CodeNameColumn |
Name of the column containing code name.
(Inherited from BaseObjectSelector.) | |
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.) | |
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.) | |
DefaultProperties |
Control properties
(Inherited from FormEngineUserControl.) | |
DependsOnAnotherField |
Indicates if field depends on another field.
(Inherited from FormEngineUserControl.) | |
DisplayGlobalItems |
Indicates whether site records are to be offered. Default value is based on IncludeGlobalItems property.
| |
DisplayOnlyEnabled |
Allows to display only enabled items. Default value is true.
(Inherited from BaseObjectSelector.) | |
DisplaySiteItems |
Indicates whether site records are to be offered. Default value is based on IncludeGlobalItems property.
| |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
(Inherited from FormEngineUserControl.) | |
EmptyObject |
Empty info object of the same type as selected objects.
(Inherited from BaseObjectSelector.) | |
Enabled |
Gets or sets the enabled state of the selector.
(Inherited from BaseObjectSelector.) | |
EnabledColumn |
Name of the column containing enabled flag.
(Inherited from BaseObjectSelector.) | |
EnsureSelectedItem |
Indicates whether selected item must be on the list despite of other settings. Default value is false.
(Inherited from BaseObjectSelector.) | |
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.) | |
Form |
Parent form.
(Inherited from FormEngineUserControl.) | |
FormControlParameter |
Helper property to use custom parameter in form control.
(Inherited from FormEngineUserControl.) | |
HasData |
Indicates if selector has data.
(Inherited from BaseObjectSelector.) | |
HasDependingFields |
Indicates if another fields depend on this field.
(Inherited from FormEngineUserControl.) | |
HasValue |
Returns true if the control has value, if false, the value from the control should not be used within the form to update the data
(Inherited from FormEngineUserControl.) | |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
IDColumn |
Name of the column containing ID.
(Inherited from BaseObjectSelector.) | |
IncludeGlobalItems |
Indicates whether global objects are to be offered.
| |
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.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
ObjectType |
Object type name of selected objects.
(Inherited from BaseObjectSelector.) | |
Parameter |
Control parameter.
(Inherited from InlineUserControl.) | |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
RememberOriginalValue |
If true, the control remembers the original value for evaluation
(Inherited from FormEngineUserControl.) | |
ResolverName |
Gets or sets macro resolver name.
(Inherited from FormEngineUserControl.) | |
ResourcePrefix |
Gets or sets resource prefix for custom texts.
(Inherited from FormEngineUserControl.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
SelectedID |
Gets or sets the ID of selected item.
(Inherited from BaseObjectSelector.) | |
SelectedName |
Gets or sets the codename of selected item.
(Inherited from BaseObjectSelector.) | |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
SiteID |
Allows to display records only for specified site ID. Use 0 for global objects. Default value is current site ID.
(Overrides BaseObjectSelectorSiteID.) | |
SiteIDColumn |
Name of the column containing ID of the site.
(Inherited from BaseObjectSelector.) | |
StopProcessing |
If true, control does not process the data.
(Inherited from BaseObjectSelector.) | |
Text |
Gets or sets Value converted to string.
(Inherited from FormEngineUserControl.) | |
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.) | |
UniSelector |
Getter to be overridden. Gets uniselector object used for selecting objects.
(Inherited from BaseObjectSelector.) | |
UseNameForSelection |
Indicates whether code name is to be used for selecting items.
(Inherited from BaseObjectSelector.) | |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ValidationError |
Validation error string shown when the control is not valid.
(Inherited from FormEngineUserControl.) | |
Value |
Gets or sets the selected value.
(Inherited from BaseObjectSelector.) | |
ValueDisplayName |
Gets the display name of the value item. Returns null if display name is not available.
(Inherited from BaseObjectSelector.) | |
ValueElementID |
Returns ClientID of the dropdown list.
(Inherited from BaseObjectSelector.) | |
ValueForValidation |
Returns value prepared for validation.
(Inherited from FormEngineUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
WhereConditionFormat |
Format of where condition.
(Inherited from FormEngineUserControl.) |
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AppendAdditionalItemsWhere |
Appends where adding additional items.
(Inherited from BaseObjectSelector.) | |
AppendEnabledWhere |
Appends where restricting to enabled items.
(Inherited from BaseObjectSelector.) | |
AppendExclusiveWhere |
Appends restrictive part of where condition to given where condition.
(Overrides BaseObjectSelectorAppendExclusiveWhere(String).) | |
AppendInclusiveWhere |
Appends widening part of where condition to given where condition.
(Inherited from BaseObjectSelector.) | |
AppendSelectedItemWhere |
Appends where condition including selected item.
(Inherited from BaseObjectSelector.) | |
AppendSiteWhere |
Appends site where to given where condition.
| |
ConnectToForm |
Connects the given form control to a form if necessary
(Inherited from FormEngineUserControl.) | |
ContainsColumn |
Indicates if form control's DataRow contains requested column.
(Inherited from FormEngineUserControl.) | |
ConvertInputValue |
Ensures that the given value is represented as null is empty, or converted to proper type.
(Inherited from FormEngineUserControl.) | |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
Form_ControlWithDependenciesChanged |
Another form control, which has some dependencies, has changed.
(Inherited from FormEngineUserControl.) | |
GenerateBaseWhere |
Returns base where condition. This condition is applied always.
Returns empty where condition by default - override this method to generate custom condition.
(Inherited from BaseObjectSelector.) | |
GenerateWhereCondition |
Generates where condition for uniselector.
(Inherited from BaseObjectSelector.) | |
GetCodeName |
Converts ID of the object to its codename.
(Inherited from BaseObjectSelector.) | |
GetColumnValue |
Gets the given column value from the form data
(Inherited from FormEngineUserControl.) | |
GetControlInfoMarker |
Gets the control info marker code
(Inherited from FormEngineUserControl.) | |
GetDialogConfiguration |
Returns dialog configuration from the specified form control settings.
(Inherited from FormEngineUserControl.) | |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetID |
Converts object name to ID on the specific site
(Inherited from BaseObjectSelector.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetNewItemUrl |
Returns url of quick add dialog.
(Inherited from BaseObjectSelector.) | |
GetOtherValue |
Returns a value of other field with specified returned by the control.
(Inherited from FormEngineUserControl.) | |
GetOtherValues |
Returns an array of values of any other fields returned by the control.
(Inherited from FormEngineUserControl.) | |
GetResolvedValueReturnType |
Gets resolved property value
(Inherited from FormEngineUserControl.) | |
GetSpellCheckFields |
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
(Inherited from FormEngineUserControl.) | |
GetString |
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.) | |
GetStringValue |
Gets the string value from the given value
(Inherited from FormEngineUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from FormEngineUserControl.) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetWhereCondition |
Gets a where condition.
Returns where condition formatted by WhereConditionFormat from IFilterFormControl interface if form control implements it.
Otherwise returns where condition in [FieldName] = 'Value' format.
(Inherited from FormEngineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
InitSelector |
Initializes the selector.
(Overrides BaseObjectSelectorInitSelector.) | |
IsValid |
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
(Inherited from FormEngineUserControl.) | |
LoadControlFromFFI |
Loads control with values in FormFieldInfo.
(Inherited from FormEngineUserControl.) | |
LoadControlValue |
Loads control value.
(Inherited from FormEngineUserControl.) | |
LoadDefaultProperties |
Loads the default properties from the given form definition
(Inherited from FormEngineUserControl.) | |
LoadOtherValues |
Loads the other fields values to the state of the form control
(Inherited from FormEngineUserControl.) | |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnAfterRetrieveData |
Called after selector data are retrieved.
(Inherited from BaseObjectSelector.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Initializes of the selector.
(Inherited from BaseObjectSelector.) | |
OnListItemCreated |
Called when item in selector is created.
(Inherited from BaseObjectSelector.) | |
OnLoad |
Load data for selector.
(Inherited from BaseObjectSelector.) | |
OnPreRender |
PreRender event handler.
(Inherited from AbstractUserControl.) | |
RaiseOnChanged |
Raises the Changed event.
(Inherited from FormEngineUserControl.) | |
Reload |
Reloads selector.
(Inherited from BaseObjectSelector.) | |
ReloadControl |
Reloads form control content.
(Inherited from FormEngineUserControl.) | |
ReloadControlInternal |
Virtual method that can be used in specific form control to reload its content.
It is called after the change of another form control which has some dependencies.
(Inherited from FormEngineUserControl.) | |
Render |
Renders user control.
(Inherited from FormEngineUserControl.) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
SetValue(String, Object) |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.) | |
SetValue(String, Object, Boolean) |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) | |
TrimDecimalValue |
Trims trailing zero values on decimal value.
(Inherited from FormEngineUserControl.) | |
UnderlyingFormControl_Changed |
Changed handler.
(Inherited from FormEngineUserControl.) | |
ValidateMacroValue |
Returns true if the given macro value is valid value for this control
(Inherited from FormEngineUserControl.) |
Name | Description | |
---|---|---|
CallHandled |
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page.
Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |
Name | Description | |
---|---|---|
Changed |
Fired on the change to the form control.
(Inherited from FormEngineUserControl.) |