SaaS CMS has officially launched! Learn more now.

AI OnAI Off

Class ScriptEventBase

Base class for all client-side event controls

Inheritance
System.Object
ScriptEventBase
ScriptAlertEvent
ScriptConfirmEvent
ScriptDisablePageLeaveEvent
ScriptEvent
ScriptReloadPageEvent
ScriptSetFocusEvent
ScriptToggleDisplayEvent
ScriptCommandEvent
ScriptResizeWindowEvent
Namespace: EPiServer.ClientScript.WebControls
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public abstract class ScriptEventBase : Control

Constructors

ScriptEventBase()

Declaration
protected ScriptEventBase()

Properties

CommonSettingsControlID

Id of a control used for common settings when traversing the settings hierachy.

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

EventTarget

Reference to the target control for the event

Declaration
public Control EventTarget { get; set; }
Property Value
Type Description
System.Web.UI.Control

EventTargetClientID

Event target reference to a DOM node using its client id.

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

EventTargetClientNode

Event target reference to a named DOM node.

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

window, document

EventTargetID

Id of the target control for the event listener.

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

EventType

Get or set the client side event to attach to.

Declaration
public EventType EventType { get; set; }
Property Value
Type Description
EventType

Methods

CreateEvent()

Create an event to be added to the ScriptManager. This method must be overridden by all implementors.

Declaration
protected abstract EventBase CreateEvent()
Returns
Type Description
EventBase

GetTargetControl()

Get a reference to the target control

Declaration
protected virtual Control GetTargetControl()
Returns
Type Description
System.Web.UI.Control

OnPreRender(EventArgs)

Attaches the event to the ScriptManager event listener list

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

Extension Methods