Class ScriptSettingItem
Represents an client side script setting in a ScriptSettings control.
Inheritance
Implements
Inherited Members
Namespace: EPiServer.ClientScript.WebControls
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7Syntax
public class ScriptSettingItem : IStateManager
Constructors
ScriptSettingItem()
Create an empty ScriptSettingItem
Declaration
public ScriptSettingItem()
ScriptSettingItem(String, String)
Create a new ScriptSettingItem with the specified name and text.
Declaration
public ScriptSettingItem(string name, string text)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the client side setting |
System.String | text | text value of the client side setting |
ScriptSettingItem(String, String, Boolean, Boolean)
Create a new ScriptSettingItem with the specified name and text.
Declaration
public ScriptSettingItem(string name, string text, bool textAsObject, bool enabled)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Name of the client side setting |
System.String | text | text value of the client side setting |
System.Boolean | textAsObject | Treat the text parameter as an object when generated to the client |
System.Boolean | enabled | Indicates if the ScriptSettingItem is enabled. |
Properties
Enabled
Get/set the items e
Declaration
public bool Enabled { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsTrackingViewState
Whether the control is tracking its view state
Declaration
public virtual bool IsTrackingViewState { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
The name of the setting generated to the client.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Text
The text generated to the client
Declaration
public string Text { get; set; }
Property Value
Type | Description |
---|---|
System.String |
TextAsObject
Whether the value of the text parameter is generated as an object or as text.
Declaration
public bool TextAsObject { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
GetHashCode()
Get the controls hash code
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | The items hash code |
Overrides
LoadViewState(Object)
Restores the control state from view state information
Declaration
public virtual void LoadViewState(object state)
Parameters
Type | Name | Description |
---|---|---|
System.Object | state | State information |
SaveViewState()
Get view state changes that have occured since last postback.
Declaration
public virtual object SaveViewState()
Returns
Type | Description |
---|---|
System.Object | The controls current view state |
SetDirty()
Set the controls view state information as dirty.
Declaration
public void SetDirty()
TrackViewState()
Starts tracking of the controls view state.
Declaration
public virtual void TrackViewState()