Click or drag to resize
SelectSettingsCategory Class
Form control for the settings category selection.
Inheritance Hierarchy

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23
Syntax
C#
public class SelectSettingsCategory : FormControl

The SelectSettingsCategory type exposes the following members.

Constructors
  NameDescription
Public methodSelectSettingsCategory
Constructor.
Top
Methods
  NameDescription
Protected methodCreateChildControls
Renders the control at run-time.
(Inherited from CMSDynamicWebControl.)
Protected methodEnsureChildControlControlType
Ensures the first found child control of the given type in the given variable
(Inherited from FormControl.)
Protected methodEnsureInitialization
Initializes the control. Is called within InitComplete or
(Inherited from CMSDynamicWebControl.)
Public methodGetValue(String)
Returns the value of the given web part property property.
(Inherited from FormControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given web part property property.
(Inherited from FormControl.)
Protected methodInitializeControl
Loads the form control
(Inherited from FormControl.)
Protected methodLoadViewState
Customized LoadViewState.
(Inherited from CMSDynamicWebControl.)
Protected methodOnInit
Init event handler.
(Inherited from CMSDynamicWebControl.)
Protected methodOnLoad
OnLoad event.
(Overrides CMSDynamicWebControlOnLoad(EventArgs).)
Protected methodOnPreRender
OnPreRender override.
(Inherited from FormControl.)
Protected methodPage_InitComplete
Event handler of page's init complete.
(Inherited from CMSDynamicWebControl.)
Public methodReload
Reloads inner controls. Can be used after additional initialization.
(Inherited from FormControl.)
Protected methodSaveViewState
Customized SaveViewState.
(Inherited from CMSDynamicWebControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from FormControl.)
Top
Extension Methods
  NameDescription
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Properties
  NameDescription
Public propertyAutoPostBack
Gets or sets whether a postback automatically occurs.
(Inherited from FormControl.)
Public propertyCssClass
Control CSS class.
(Inherited from FormControl.)
Public propertyCurrentCategoryId
Gets or sets ID of the Category which will be not included in the list control so its children.
Protected propertyDisabledItems
Indexes of categories, which have to be disabled e.g. '0|1|5|9|'.
Public propertyDisplayOnlyCategories
Gets or sets DisplayOnlyCategories property. If set to false groups will be displayed as well.
Public propertyEditingControl
Editing control.
(Inherited from FormControl.)
Public propertyEnabled
Gets or sets state enable.
(Inherited from FormControl.)
Public propertyEnabledCondition
Gets or sets Enabled condition.
Public propertyField
Field name for the inner controls. This property is only supported in templated form.
(Inherited from FormControl.)
Public propertyForm
Form where the control is used.
(Inherited from FormControl.)
Public propertyFormControlName
Form control name.
(Inherited from FormControl.)
Public propertyFormFieldInfo
FormFieldInfo for current control.
(Inherited from FormControl.)
Public propertyCheckUnique
If true, the field is checked for uniqueness. This property is only supported in UIForm.
(Inherited from FormControl.)
Public propertyIncludeRootCategory
Gets or sets enabled state of inclusion of RootCategory. Default false.
Public propertyInitCompleted
If true, the initialization of the control has already completed and won't repeat. Set to true in your initialization code.
(Inherited from CMSDynamicWebControl.)
Protected propertyInitEarly
If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event.
(Inherited from CMSDynamicWebControl.)
Public propertyIsKeyEdit
If set to true selector is used in settings key edit form, so all items representing categories (not group) will be disabled and with different color.
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from FormControl.)
Public propertyItems
Gets the collection of items in the list control.
Public propertyProperties
Properties definition.
(Inherited from FormControl.)
Public propertyRootCategoryId
Gets or sets ID of the Category which will be the root of the tree structure.
Public propertySelectedCategory
Gets the value of the selected Category in the list control, or selects the Category in the list control that contains the specified value.
Public propertyShortID
Short ID of the control.
(Inherited from FormControl.)
Public propertyStartingPath
Gets or sets Enabled condition.
Public propertyStopProcessing
Indicates if processing of the code of this control should continue. It can be used after raising an event.
(Inherited from CMSDynamicWebControl.)
Public propertySubItemPrefix
Gets or sets SubItemPrefix.
Protected propertyTagKey
TagKey used to render (Div).
(Inherited from FormControl.)
Public propertyText
Gets or sets value converted to string
(Inherited from FormControl.)
Public propertyTrim
If true, the value is trimmed. This property is only supported if used inside the form control.
(Inherited from FormControl.)
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Public propertyUseFFI
Indicates if control should load properties from FormFieldInfo. Default TRUE.
(Inherited from FormControl.)
Public propertyValue
Value used for initialization as default value.
(Inherited from FormControl.)
Public propertyWhereCondition
Gets or sets WHERE condition.
Top
See Also