Click or drag to resize
BaseObjectSelector Class
Abstract class providing common functionality for ecommerce objects selectors.
Inheritance Hierarchy

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 9.0.0
Syntax
C#
public abstract class BaseObjectSelector : FormEngineUserControl

The BaseObjectSelector type exposes the following members.

Constructors
  NameDescription
Protected methodBaseObjectSelector
Top
Fields
  NameDescription
Protected fieldmViewStateTracked
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.)
Top
Properties
  NameDescription
Public propertyAddAllItemsRecord
Gets or sets the value which determines, whether to add 'all' item record to the selector.
Public propertyAdditionalItems
ID of items which have to be displayed. Use ',' or ';' as separator if more IDs required.
Public propertyAddNoneRecord
Determines whether to add 'none' item record to the selector.
Protected propertyAllowCombineSiteAndGlobal
Indicates if objects can be combined site and global within one site. False means that site can use only global or only site records.
Public propertyAllowCreate
Indicates whether new button will be visible and creating of new object allowed.
Public propertyAutoPostBack
Determines whether the AutoPostBack property of dropdown list should be enabled.
Protected propertyCodeNameColumn
Name of the column containing code name.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContextResolver
Gets or sets macro resolver for given control.
(Inherited from FormEngineUserControl.)
Public propertyControlStyle
CSS style of the control.
(Inherited from FormEngineUserControl.)
Public propertyCssClass
CSS class of the control.
(Inherited from FormEngineUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyData
Node data. This property is used only for passing values to the control.
(Inherited from FormEngineUserControl.)
Public propertyDefaultProperties
Control properties
(Inherited from FormEngineUserControl.)
Public propertyDependsOnAnotherField
Indicates if field depends on another field.
(Inherited from FormEngineUserControl.)
Public propertyDisplayOnlyEnabled
Allows to display only enabled items. Default value is true.
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from AbstractUserControl.)
Protected propertyEmptyObject
Empty info object of the same type as selected objects.
Public propertyEnabled
Gets or sets the enabled state of the selector.
(Overrides FormEngineUserControlEnabled.)
Protected propertyEnabledColumn
Name of the column containing enabled flag.
Public propertyEnsureSelectedItem
Indicates whether selected item must be on the list despite of other settings. Default value is false.
Public propertyErrorMessage
Control custom error message.
(Inherited from FormEngineUserControl.)
Public propertyField
Field name to which the field belongs.
(Inherited from FormEngineUserControl.)
Public propertyFieldInfo
Field info object.
(Inherited from FormEngineUserControl.)
Public propertyForm
Parent form.
(Inherited from FormEngineUserControl.)
Public propertyFormControlParameter
Helper property to use custom parameter in form control.
(Inherited from FormEngineUserControl.)
Public propertyHasData
Indicates if selector has data.
Public propertyHasDependingFields
Indicates if another fields depend on this field.
(Inherited from FormEngineUserControl.)
Public propertyHasValue
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.)
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyCheckFieldEmptiness
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.)
Public propertyCheckMinMaxLength
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.)
Public propertyCheckRegularExpression
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.)
Public propertyCheckUnique
If true, the field is checked for uniqueness. This property is only supported in templated form.
(Inherited from FormEngineUserControl.)
Protected propertyIDColumn
Name of the column containing ID.
Public propertyInputClientID
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.)
Public propertyInputControlID
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.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Protected propertyObjectType
Object type name of selected objects.
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRememberOriginalValue
If true, the control remembers the original value for evaluation
(Inherited from FormEngineUserControl.)
Public propertyResolverName
Gets or sets macro resolver name.
(Inherited from FormEngineUserControl.)
Public propertyResourcePrefix
Gets or sets resource prefix for custom texts.
(Inherited from FormEngineUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertySelectedID
Gets or sets the ID of selected item.
Public propertySelectedName
Gets or sets the codename of selected item.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertySiteID
Allows to display records only for specified site ID.
Protected propertySiteIDColumn
Name of the column containing ID of the site.
Public propertyStopProcessing
If true, control does not process the data.
(Overrides FormEngineUserControlStopProcessing.)
Public propertyText
Gets or sets Value converted to string.
(Inherited from FormEngineUserControl.)
Public propertyTrim
If true, the returned value is trimmed. This property is only supported if used inside the form control. Default false.
(Inherited from FormEngineUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from AbstractUserControl.)
Protected propertyUnderlyingFormControl
Underlying form control, if provided, the form control automatically redirects all properties to that control
(Inherited from FormEngineUserControl.)
Public propertyUniSelector
Getter to be overridden. Gets uniselector object used for selecting objects.
Public propertyUseNameForSelection
Indicates whether code name is to be used for selecting items.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyValidationError
Validation error string shown when the control is not valid.
(Inherited from FormEngineUserControl.)
Public propertyValue
Gets or sets the selected value.
(Overrides FormEngineUserControlValue.)
Public propertyValueDisplayName
Gets the display name of the value item. Returns null if display name is not available.
(Overrides FormEngineUserControlValueDisplayName.)
Public propertyValueElementID
Returns ClientID of the dropdown list.
(Overrides FormEngineUserControlValueElementID.)
Public propertyValueForValidation
Returns value prepared for validation.
(Inherited from FormEngineUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereConditionFormat
Format of where condition.
(Inherited from FormEngineUserControl.)
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Protected methodAppendAdditionalItemsWhere
Appends where adding additional items.
Protected methodAppendEnabledWhere
Appends where restricting to enabled items.
Protected methodAppendExclusiveWhere
Appends restrictive part of where condition to given where condition.
Protected methodAppendInclusiveWhere
Appends widening part of where condition to given where condition.
Protected methodAppendSelectedItemWhere
Appends where condition including selected item.
Protected methodConnectToForm
Connects the given form control to a form if necessary
(Inherited from FormEngineUserControl.)
Protected methodContainsColumn
Indicates if form control's DataRow contains requested column.
(Inherited from FormEngineUserControl.)
Protected methodConvertInputValue
Ensures that the given value is represented as null is empty, or converted to proper type.
(Inherited from FormEngineUserControl.)
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodForm_ControlWithDependenciesChanged
Another form control, which has some dependencies, has changed.
(Inherited from FormEngineUserControl.)
Protected methodGenerateBaseWhere
Returns base where condition. This condition is applied always. Returns empty where condition by default - override this method to generate custom condition.
Protected methodGenerateWhereCondition
Generates where condition for uniselector.
Protected methodGetCodeName
Converts ID of the object to its codename.
Protected methodGetColumnValue
Gets the given column value from the form data
(Inherited from FormEngineUserControl.)
Public methodGetControlInfoMarker
Gets the control info marker code
(Inherited from FormEngineUserControl.)
Protected methodGetDialogConfiguration
Returns dialog configuration from the specified form control settings.
(Inherited from FormEngineUserControl.)
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Protected methodGetID
Converts object name to ID on the specific site
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Protected methodGetInputClientID
Gets client ID of first inner control.
(Inherited from FormEngineUserControl.)
Protected methodGetInputControlID
Gets control ID of first inner control.
(Inherited from FormEngineUserControl.)
Protected methodGetNewItemUrl
Returns url of quick add dialog.
Public methodGetOtherValue
Returns a value of other field with specified returned by the control.
(Inherited from FormEngineUserControl.)
Public methodGetOtherValues
Returns an array of values of any other fields returned by the control.
(Inherited from FormEngineUserControl.)
Public methodGetResolvedValueReturnType
Gets resolved property value
(Inherited from FormEngineUserControl.)
Public methodGetSpellCheckFields
Returns the list of the field IDs (Client IDs of the inner controls) that should be spell checked.
(Inherited from FormEngineUserControl.)
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Protected methodGetStringValue
Gets the string value from the given value
(Inherited from FormEngineUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from FormEngineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetWhereCondition
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.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Protected methodInitSelector
Initializes the selector.
Public methodIsValid
Returns true if entered data is valid. If data is invalid, it returns false and displays an error message.
(Inherited from FormEngineUserControl.)
Public methodLoadControlFromFFI
Loads control with values in FormFieldInfo.
(Inherited from FormEngineUserControl.)
Public methodLoadControlValue
Loads control value.
(Inherited from FormEngineUserControl.)
Public methodLoadDefaultProperties
Loads the default properties from the given form definition
(Inherited from FormEngineUserControl.)
Public methodLoadOtherValues
Loads the other fields values to the state of the form control
(Inherited from FormEngineUserControl.)
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Protected methodOnAfterRetrieveData
Called after selector data are retrieved.
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Initializes of the selector.
(Overrides FormEngineUserControlOnInit(EventArgs).)
Protected methodOnListItemCreated
Called when item in selector is created.
Protected methodOnLoad
Load data for selector.
(Overrides AbstractUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Protected methodRaiseOnChanged
Raises the Changed event.
(Inherited from FormEngineUserControl.)
Public methodReload
Reloads selector.
Protected methodReloadControl
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.)
Protected methodRender
Renders user control.
(Inherited from FormEngineUserControl.)
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetValue(String, Object)
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.)
Public methodSetValue(String, Object, Boolean)
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormEngineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Protected methodUnderlyingFormControl_Changed
Changed handler.
(Inherited from FormEngineUserControl.)
Public methodValidateMacroValue
Returns true if the given macro value is valid value for this control
(Inherited from FormEngineUserControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventChanged
Fired on the change to the form control.
(Inherited from FormEngineUserControl.)
Top
See Also