Try our conversational search powered by Generative AI!

Class ToolButton

Inheritance
System.Object
ToolButton
Implements
System.Web.UI.IPostBackEventHandler
System.Web.UI.WebControls.IButtonControl
System.Web.UI.IPostBackDataHandler
Namespace: EPiServer.UI.WebControls
Assembly: EPiServer.UI.dll
Version: 11.20.7
Syntax
public class ToolButton : WebControl, IPostBackEventHandler, IButtonControl, IPostBackDataHandler

Constructors

ToolButton()

Declaration
public ToolButton()

Properties

AlternateText

Declaration
[Obsolete("No longer used since there is no inner image to set the alt text for")]
public string AlternateText { get; set; }
Property Value
Type Description
System.String

CausesValidation

Declaration
public bool CausesValidation { get; set; }
Property Value
Type Description
System.Boolean

CommandArgument

Declaration
public string CommandArgument { get; set; }
Property Value
Type Description
System.String

CommandName

Declaration
public string CommandName { get; set; }
Property Value
Type Description
System.String

CommonSettingsControlID

Declaration
public string CommonSettingsControlID { get; set; }
Property Value
Type Description
System.String

ConfirmMessage

Declaration
public string ConfirmMessage { get; set; }
Property Value
Type Description
System.String

CssClassInnerButton

Declaration
public string CssClassInnerButton { get; set; }
Property Value
Type Description
System.String

CssClassInnerImage

Declaration
[Obsolete("No longer used since there is no inner image")]
public string CssClassInnerImage { get; set; }
Property Value
Type Description
System.String

DisablePageLeaveCheck

Declaration
public bool DisablePageLeaveCheck { get; set; }
Property Value
Type Description
System.Boolean

EnableClientConfirm

Declaration
public bool EnableClientConfirm { get; set; }
Property Value
Type Description
System.Boolean

GeneratesPostBack

Declaration
public virtual bool GeneratesPostBack { get; set; }
Property Value
Type Description
System.Boolean

ImageUrl

Declaration
public virtual string ImageUrl { get; set; }
Property Value
Type Description
System.String

IsDialogButton

Declaration
public bool IsDialogButton { get; set; }
Property Value
Type Description
System.Boolean

OnClientClick

Declaration
public virtual string OnClientClick { get; set; }
Property Value
Type Description
System.String

PostBackUrl

Declaration
public string PostBackUrl { get; set; }
Property Value
Type Description
System.String

RequiredAccess

Declaration
public AccessLevel RequiredAccess { get; set; }
Property Value
Type Description
AccessLevel

RichToolTip

Declaration
public string RichToolTip { get; set; }
Property Value
Type Description
System.String

Text

Declaration
public string Text { get; set; }
Property Value
Type Description
System.String

ToolTip

Declaration
public override string ToolTip { get; set; }
Property Value
Type Description
System.String

ValidationGroup

Declaration
public string ValidationGroup { get; set; }
Property Value
Type Description
System.String

Methods

AddAttributesToRender(HtmlTextWriter)

Declaration
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer

CreateChildControls()

Declaration
protected override void CreateChildControls()

GetPostBackOptions()

Declaration
protected virtual PostBackOptions GetPostBackOptions()
Returns
Type Description
System.Web.UI.PostBackOptions

LoadPostData(String, NameValueCollection)

Declaration
public virtual bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters
Type Name Description
System.String postDataKey
System.Collections.Specialized.NameValueCollection postCollection
Returns
Type Description
System.Boolean

OnClick(EventArgs)

Declaration
protected virtual void OnClick(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

OnCommand(CommandEventArgs)

Declaration
protected virtual void OnCommand(CommandEventArgs e)
Parameters
Type Name Description
System.Web.UI.WebControls.CommandEventArgs e

OnPreRender(EventArgs)

Declaration
protected override void OnPreRender(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

RaisePostBackEvent(String)

Declaration
public void RaisePostBackEvent(string eventArgument)
Parameters
Type Name Description
System.String eventArgument

RaisePostDataChangedEvent()

Declaration
public virtual void RaisePostDataChangedEvent()

RenderChildren(HtmlTextWriter)

Declaration
protected override void RenderChildren(HtmlTextWriter writer)
Parameters
Type Name Description
System.Web.UI.HtmlTextWriter writer

Events

Click

Declaration
public event EventHandler Click
Event Type
Type Description
System.EventHandler

Command

Declaration
public event CommandEventHandler Command
Event Type
Type Description
System.Web.UI.WebControls.CommandEventHandler

Implements

System.Web.UI.IPostBackEventHandler
System.Web.UI.WebControls.IButtonControl
System.Web.UI.IPostBackDataHandler

Extension Methods