Click or drag to resize
CMSToggleButton Class
Multi button which displays first action only as a label which opens dropdown list with other actions.
Inheritance Hierarchy

Namespace: CMS.ExtendedControls
Assembly: CMS.ExtendedControls (in CMS.ExtendedControls.dll) Version: 8.2.23
Syntax
C#
public class CMSToggleButton : CMSMultiButtonBase

The CMSToggleButton type exposes the following members.

Constructors
  NameDescription
Public methodCMSToggleButton
Top
Methods
  NameDescription
Protected methodCreateButtonForOneAction
Creates button which is rendered when there is only one CMSButtonAction added.
(Inherited from CMSMultiButtonBase.)
Protected methodCreateListItem
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 methodCreateListItemHyperLink
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 methodGetActionOnClientClick
Creates javascript code which triggers postback to this control and optionally additional client code specified by the CMSButtonAction OnClientClick property.
(Inherited from CMSMultiButtonBase.)
Protected methodInitChildControlsForMoreThanOneActions
Initializes Controls collection if there are more than one actions added.
(Inherited from CMSMultiButtonBase.)
Protected methodInitChildControlsForOneAction
Initializes the Controls collection when only one CMSButtonAction is present.
(Inherited from CMSMultiButtonBase.)
Protected methodInitOpeningButtonControls
Creates first button which will open dropdown with other actions. This button does not perform action itself.
(Overrides CMSMultiButtonBaseInitOpeningButtonControls(CMSButtonAction).)
Protected methodOnInit
Sets class class.
(Overrides CMSWebControlOnInit(EventArgs).)
Protected methodOnPreRender
Creates controls which are rendered in the Render phase.
(Inherited from CMSMultiButtonBase.)
Public methodRaisePostBackEvent
Enables a server control to process an event raised when a form is posted to the server.
(Inherited from CMSMultiButtonBase.)
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 propertyActions
Button actions. Has to be set before PreRender event.
(Inherited from CMSMultiButtonBase.)
Public propertyDropDownItemsAlignment
Indicates to which direction button actions will be aligned. Default is LEFT.
(Inherited from CMSMultiButtonBase.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from CMSWebControl.)
Public propertyShortID
Short ID of the control.
(Inherited from CMSWebControl.)
Public propertyUIContext
Returns control's UI context
(Inherited from CMSWebControl.)
Top
Events
  NameDescription
Public eventClick
Occurs when button in button group is clicked
(Inherited from CMSMultiButtonBase.)
Top
See Also