CMSToggleButton Class

Multi button which displays first action only as a label which opens dropdown list with other actions.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      CMS.Base.Web.UI.CMSWebControl
        CMS.Base.Web.UI.CMSMultiButtonBase
          CMS.Base.Web.UI.CMSToggleButton
            CMS.Base.Web.UI.CMSSelectableToggleButton

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 13.0.131

Syntax

public class CMSToggleButton : CMSMultiButtonBase

The CMSToggleButton type exposes the following members.

Constructors

	Name	Description
Public method	CMSToggleButton

Properties

	Name	Description
Public property	Actions	Button actions. Has to be set before PreRender event. (Inherited from CMSMultiButtonBase.)
Public property	DropDownItemsAlignment	Indicates to which direction button actions will be aligned. Default is LEFT. (Inherited from CMSMultiButtonBase.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSWebControl.)
Public property	RenderFirstActionSeparately	Indicates if the first action should be rendered as part of the primary button. (Inherited from CMSMultiButtonBase.)
Public property	ShortID	Short ID of the control. (Inherited from CMSWebControl.)

Methods

	Name	Description
Protected method	CreateButtonForOneAction	Creates button which is rendered when there is only one CMSButtonAction added. (Inherited from CMSMultiButtonBase.)
Protected method	CreateListItem	Creates one dropdown list item when there are more than one actions added. List item contains hyperlink which triggers postback when clicked. (Inherited from CMSMultiButtonBase.)
Protected method	CreateListItemHyperLink	Creates hyperlink which is used as a content of the list item. This is the clickable part of the dropdown list. (Inherited from CMSMultiButtonBase.)
Protected method	GetActionOnClientClick	Creates javascript code which triggers postback to this control and optionally additional client code specified by the CMSButtonAction OnClientClick property. (Inherited from CMSMultiButtonBase.)
Protected method	InitChildControlsForMoreThanOneActions	Initializes Controls collection if there are more than one actions added. (Inherited from CMSMultiButtonBase.)
Protected method	InitChildControlsForOneAction	Initializes the Controls collection when only one CMSButtonAction is present. (Inherited from CMSMultiButtonBase.)
Protected method	InitOpeningButtonControls	Creates first button which will open dropdown with other actions. This button does not perform action itself. (Overrides CMSMultiButtonBase.InitOpeningButtonControls(CMSButtonAction).)
Protected method	OnInit	Sets class class. (Overrides CMSWebControl.OnInit(EventArgs).)
Protected method	OnPreRender	Creates controls which are rendered in the Render phase. (Inherited from CMSMultiButtonBase.)
Public method	RaisePostBackEvent	Enables a server control to process an event raised when a form is posted to the server. (Inherited from CMSMultiButtonBase.)

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	Click	Occurs when button in button group is clicked (Inherited from CMSMultiButtonBase.)