FormSubmitButton Class

Form button control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.Button
        CMS.Base.Web.UI.CMSButton
          CMS.Base.Web.UI.LocalizedButton
            CMS.FormEngine.Web.UI.FormSubmitButton

Namespace: CMS.FormEngine.Web.UI
Assembly: CMS.FormEngine.Web.UI (in CMS.FormEngine.Web.UI.dll) Version: 12.0.0

Syntax

public class FormSubmitButton : LocalizedButton

The FormSubmitButton type exposes the following members.

Constructors

	Name	Description
Public method	FormSubmitButton	Constructor.

Properties

	Name	Description
Public property	Action	Header action to be inserted to the header actions.
Public property	ButtonStyle	Gets or sets the style of the button. (Inherited from CMSButton.)
Public property	ComponentName	Component name (Inherited from CMSButton.)
Public property	DisableAfterSubmit	Indicates whether button should disable its click handler upon first click. (Inherited from CMSButton.)
Public property	Form	Form
Public property	HeaderActions	Header actions control
Public property	IconCssClass	Gets or sets the CSS class that serves as icon for the button. Icon is by default rendered before text. Position of the icon can be overriden by using expression ICON_PLACEMENT_MACRO inside the text property. (Inherited from CMSButton.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from CMSButton.)
Public property	RegisterHeaderAction	Indicates if header action should be registered. The submit button is hidden and Save header action is added.
Public property	RenderInputTag	When true input tag is rendered instead of button tag. (Inherited from CMSButton.)
Public property	RenderScript	Indicates if java script methods for enabling/disabling button should be generated. (Inherited from CMSButton.)
Public property	ResourceString	Name of a resource string used for text. (Inherited from LocalizedButton.)
Public property	Source	Localized string source property - may be 'database' or 'file'. (Inherited from LocalizedButton.)
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from CMSButton.)
Protected property	TagKey	HTML tag for this control. (Inherited from CMSButton.)
Public property	Text	Text displayed in button control. (Inherited from CMSButton.)
Public property	ToolTip	Tooltip text. (Inherited from CMSButton.)
Public property	ToolTipResourceString	Name of a resource string used for tooltip. (Inherited from LocalizedButton.)

Methods

	Name	Description
Protected method	OnLoad	OnLoad event (Overrides Control.OnLoad(EventArgs).)
Protected method	OnPreRender	Refreshes buttons's text on pre-render. (Inherited from LocalizedButton.)
Protected method	Render	Renders the button. (Inherited from CMSButton.)
Protected method	RenderContents	Renders content. (Inherited from CMSButton.)

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