OptionsDesigner Class

Control provides editing of field options.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.CompositeControl
        CMS.FormControls.OptionsDesigner

Namespace: CMS.FormControls
Assembly: CMS.FormControls (in CMS.FormControls.dll) Version: 9.0.0

Syntax

public class OptionsDesigner : CompositeControl

The OptionsDesigner type exposes the following members.

Constructors

	Name	Description
Public method	OptionsDesigner

Fields

	Name	Description
Public field Static member	DEFAULT_OPTION	Default option name - used as a prefix with number

Properties

	Name	Description
Public property	AllowMultipleChoice	Indicates if more than one option can be selected.
Public property	OptionsDefinition	Gets or sets options definition in format "value;name" separated by new line.
Public property	Value	Gets or sets options selected by default in format "option1|option2".

Methods

	Name	Description
Public method	GenerateOptions	Generates options controls by the options definition.
Public method Static member	GetUniqueItem	Returns unique value in format "prefix{number}" where number will be higher than highest number from source options. (Apply only to strings in format "prefix{number}").
Protected method	LoadViewState	Customized LoadViewState. (Overrides WebControl.LoadViewState(Object).)
Protected method	OnInit	Init event handler. (Overrides Control.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	Pre-render event hadler. (Overrides Control.OnPreRender(EventArgs).)
Protected method	RaiseOnOptionChanged	Raise option added event handler.
Protected method	SaveViewState	Customized SaveViewState. (Overrides WebControl.SaveViewState().)

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	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	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 ControlsExtensions.)
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.)

Events

	Name	Description
Public event	OptionAdded	Fired if new option is added.