SelectSettingsCategory Class

Form control for the settings category selection.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.ExtendedControls.CMSWebControl
        CMS.ExtendedControls.CMSDynamicWebControl
          CMS.FormControls.FormControl
            CMS.UIControls.SelectSettingsCategory

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 8.2.23

Syntax

public class SelectSettingsCategory : FormControl

The SelectSettingsCategory type exposes the following members.

Constructors

	Name	Description
Public method	SelectSettingsCategory	Constructor.

Methods

	Name	Description
Protected method	CreateChildControls	Renders the control at run-time. (Inherited from CMSDynamicWebControl.)
Protected method	EnsureChildControl<ControlType>	Ensures the first found child control of the given type in the given variable (Inherited from FormControl.)
Protected method	EnsureInitialization	Initializes the control. Is called within InitComplete or (Inherited from CMSDynamicWebControl.)
Public method	GetValue(String)	Returns the value of the given web part property property. (Inherited from FormControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given web part property property. (Inherited from FormControl.)
Protected method	InitializeControl	Loads the form control (Inherited from FormControl.)
Protected method	LoadViewState	Customized LoadViewState. (Inherited from CMSDynamicWebControl.)
Protected method	OnInit	Init event handler. (Inherited from CMSDynamicWebControl.)
Protected method	OnLoad	OnLoad event. (Overrides CMSDynamicWebControl.OnLoad(EventArgs).)
Protected method	OnPreRender	OnPreRender override. (Inherited from FormControl.)
Protected method	Page_InitComplete	Event handler of page's init complete. (Inherited from CMSDynamicWebControl.)
Public method	Reload	Reloads inner controls. Can be used after additional initialization. (Inherited from FormControl.)
Protected method	SaveViewState	Customized SaveViewState. (Inherited from CMSDynamicWebControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from FormControl.)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	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.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	AutoPostBack	Gets or sets whether a postback automatically occurs. (Inherited from FormControl.)
Public property	CssClass	Control CSS class. (Inherited from FormControl.)
Public property	CurrentCategoryId	Gets or sets ID of the Category which will be not included in the list control so its children.
Protected property	DisabledItems	Indexes of categories, which have to be disabled e.g. '0|1|5|9|'.
Public property	DisplayOnlyCategories	Gets or sets DisplayOnlyCategories property. If set to false groups will be displayed as well.
Public property	EditingControl	Editing control. (Inherited from FormControl.)
Public property	Enabled	Gets or sets state enable. (Inherited from FormControl.)
Public property	EnabledCondition	Gets or sets Enabled condition.
Public property	Field	Field name for the inner controls. This property is only supported in templated form. (Inherited from FormControl.)
Public property	Form	Form where the control is used. (Inherited from FormControl.)
Public property	FormControlName	Form control name. (Inherited from FormControl.)
Public property	FormFieldInfo	FormFieldInfo for current control. (Inherited from FormControl.)
Public property	CheckUnique	If true, the field is checked for uniqueness. This property is only supported in UIForm. (Inherited from FormControl.)
Public property	IncludeRootCategory	Gets or sets enabled state of inclusion of RootCategory. Default false.
Public property	InitCompleted	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 property	InitEarly	If true, the control initializes on BeforeInitComplete, otherwise on InitComplete event. (Inherited from CMSDynamicWebControl.)
Public property	IsKeyEdit	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 property	IsLiveSite	Indicates if control is used on live site. (Inherited from FormControl.)
Public property	Items	Gets the collection of items in the list control.
Public property	Properties	Properties definition. (Inherited from FormControl.)
Public property	RootCategoryId	Gets or sets ID of the Category which will be the root of the tree structure.
Public property	SelectedCategory	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 property	ShortID	Short ID of the control. (Inherited from FormControl.)
Public property	StartingPath	Gets or sets Enabled condition.
Public property	StopProcessing	Indicates if processing of the code of this control should continue. It can be used after raising an event. (Inherited from CMSDynamicWebControl.)
Public property	SubItemPrefix	Gets or sets SubItemPrefix.
Protected property	TagKey	TagKey used to render (Div). (Inherited from FormControl.)
Public property	Text	Gets or sets value converted to string (Inherited from FormControl.)
Public property	Trim	If true, the value is trimmed. This property is only supported if used inside the form control. (Inherited from FormControl.)
Public property	UIContext	Returns control's UI context (Inherited from CMSWebControl.)
Public property	UseFFI	Indicates if control should load properties from FormFieldInfo. Default TRUE. (Inherited from FormControl.)
Public property	Value	Value used for initialization as default value. (Inherited from FormControl.)
Public property	WhereCondition	Gets or sets WHERE condition.