ScriptHelper Class

Utility methods for script manipulation.

Inheritance Hierarchy

System.Object
  CMS.Base.Web.UI.ScriptHelper

Namespace: CMS.Base.Web.UI
Assembly: CMS.Base.Web.UI (in CMS.Base.Web.UI.dll) Version: 13.0.131

Syntax

public static class ScriptHelper

The ScriptHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	BOOTSTRAP_CUSTOM_FILENAME	Filename of custom bootstrap library.
Public field Static member	BOOTSTRAP_FILENAME	Filename of bootstrap library.
Public field Static member	CLOSE_DIALOG_SCRIPT_KEY	Script registration key for centralized dialog closing.
Public field Static member	DIALOG_SCRIPT_KEY	Script registration key for the dialog script.
Public field Static member	EDIT_DOCUMENT_SCRIPT_KEY	Edit document script key.
Public field Static member	GET_TOP_SCRIPT_KEY	Script registration key for centralized retrieving of 'top' frame.
Public field Static member	JQUERY_FILENAME	Filename of jquery library
Public field Static member	JQUERY_KEY	Script registration key for jQuery JavaScript library.
Public field Static member	MOOTOOLS_FILENAME	Filename of MooTools library.
Public field Static member	MOOTOOLS_KEY	Script registration key for mootools JavaScript library.
Public field Static member	NEWWINDOW_SCRIPT_KEY	Script registration key for the non modal win script.
Public field Static member	SAVE_DOCUMENT_SCRIPT_KEY	Save document script key.
Public field Static member	SCRIPTFILE_PREFIX_KEY	Prefix used for registering script files.
Public field Static member	TOOLBAR_SCRIPT_KEY	Script registration key for the editor toolbar.
Public field Static member	TOOLTIP_SCRIPT_FILE_KEY	Script registration key for tooltip file.
Public field Static member	UNDERSCORE_FILENAME	Filename of Underscore library.
Public field Static member	UNDERSCORE_KEY	Script registration key for Underscore library.
Public field Static member	WOPENER_SCRIPT_KEY	Script registration key for cross-window scripting ("wopener").

Properties

	Name	Description
Public property Static member	AllowProgressScript	If true, progress script is allowed on pages.
Public property Static member	CapslockScript	Capslock check script (OnCasplockOn and OnCapslockOff functions must be implemented).
Public property Static member	CloseDialogScript	Script for centralized dialog closing.
Public property Static member	GetTopScript	Script for centralized retrieving of 'top' frame.
Public property Static member	MinifyCurrentRequestScripts	If true, the scripts in current request are minified.
Public property Static member	NewWindowScript	Script code for the dialog handling.
Public property Static member	OnlyNumbersScript	Only numbers script (Must be implemented in OnKeyDown event).
Public property Static member	ScriptMinificationEnabled	Gets if script minification is enabled.
Public property Static member	ToolbarScript	HTML Editor toolbar script.
Public property Static member	WOpenerScript	Cross-window scripting script ("wopener").

Methods

	Name	Description
Public method Static member	AddScript	Adds a script to an existing script
Public method Static member	AddToRegisteredClientScripts	Adds key identifying script to collection of registered scripts.
Public method Static member	AddToRegisteredStartupScripts	Adds key identifying script to collection of registered startup scripts.
Public method Static member	Alert	Renders alert script to the page
Public method Static member	AppendTooltip(WebControl, String, String)	Appends tooltip to control.
Public method Static member	AppendTooltip(HtmlGenericControl, String, String, Int32, Boolean)	Appends tooltip to control.
Public method Static member	AppendTooltip(WebControl, String, String, Int32, Boolean)	Appends tooltip to control.
Public method Static member	EnsurePostbackMethods	Ensures that the postback methods are present in the page
Public method Static member	FixPendingCallbacks	Fixes common 'pendingCallbacks' JavaScript error.
Public method Static member	FormatTooltipString	Formats string to be used for tooltip.
Public method Static member	GetAlertScript	Returns the JavaScript alert message.
Public method Static member	GetDisableProgressScript	Returns script to disable progress for a single following action.
Public method Static member	GetLayoutResizeScript	Returns script fragment performing callback when layout pane width has been changed.
Public method Static member	GetLoaderHtml	Gets the HTML content of the standard system loader.
Public method Static member	GetLoaderInlineHtml	Gets the HTML content of the standard system loader icon with specified text.
Public method Static member	GetLoaderOverlayHtml	Gets the HTML content of the standard system loader overlay.
Public method Static member	GetLocalizedString(String)	Localizes and encodes text to be used in JavaScript string and encapsulates it with "'".
Public method Static member	GetLocalizedString(String, Boolean)	Localizes and encodes text to be used in JavaScript string and optionally encapsulates it with "'".
Public method Static member	GetModalDialogScript(String, String, Int32, Int32)	Returns script which opens modal dialog.
Public method Static member	GetModalDialogScript(String, String, Int32, Int32, Boolean)	Obsolete. Returns script which opens modal dialog.
Public method Static member	GetModalDialogScript(String, String, String, String, Boolean)	Returns script which opens modal dialog.
Public method Static member	GetScript	Encloses the specified script in an HTML script element.
Public method Static member	GetScriptTag	Builds an HTML script tag that can be used to include external script given its URL. Allows to explicitly disable script minification.
Public method Static member	GetString	Encodes text to be used in JavaScript string and optionally encapsulates it with "'".
Public method Static member	HideVerticalTabs	Hides the parent vertical tabs
Public method Static member	IsClientScriptBlockRegistered	Returns whether client script with given key is already registered.
Public method Static member	IsJQueryRegistered	Determines whether jQuery library is already registered.
Public method Static member	IsMooToolsRegistered	Determines whether MooTools library is already registered.
Public method Static member	IsStartupScriptRegistered	Returns whether startup script with given key is already registered.
Public method Static member	IsUnderscoreRegistered	Determines whether Underscore JavaScript library is already registered.
Public method Static member	JsonSerializeObject	Serializes the specified object to a JSON string using default formatting
Public method Static member	RefreshTabHeader	Reload page header and select specified tab
Public method Static member	RefreshTree	Registers refresh tree script for documents UI
Public method Static member	RegisterAngularModule	Registers Angular module which will be rendered to start a client-side angular module.
Public method Static member	RegisterApplicationConstants	Ensures registration of the application constants script. It provides constants applicationUrl, imagesUrl, isRTL.
Public method Static member	RegisterBootstrapScripts	Ensures registration of Bootstrap JavaScript library.
Public method Static member	RegisterBootstrapTooltip	Ensures registration of bootstrap tooltip script.
Public method Static member	RegisterClientApplication	Registers a client script, that adds the client application state to the page, with the Page object.
Public method Static member	RegisterClientScriptBlock(Control, Type, String, String, Boolean)	Registers a client script block for AJAX and adds the script block to the page, optionally enclosing it in script tags.
Public method Static member	RegisterClientScriptBlock(Page, Type, String, String, Boolean)	Registers a client script block for AJAX and adds the script block to the page, optionally enclosing it in script tags.
Public method Static member	RegisterClientScriptInclude	Registers the client script for AJAX and then adds a script file reference to the page. Allows to explicitly disable script minification.
Public method Static member	RegisterCloseDialogScript	Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
Public method Static member	RegisterCMS	Ensures registration of the main CMS script.
Public method Static member	RegisterCompletePageScript	Registers the script which checks the page completeness on postback.
Public method Static member	RegisterDialogScript	Registers the script for modal dialogs. Provides function modalDialog(url, name, width, height, otherParams, noWopener).
Public method Static member	RegisterEditScript	Registers cmsedit.js script to the page and ensures initialization
Public method Static member	RegisterFlatResize	Ensures registration of script which causes correct resizing of uni flat selectors.
Public method Static member	RegisterGetTopScript	Registers script for centralized retrieving of 'top' frame. (Useful for dialogs.)
Public method Static member	RegisterHiddenField(Control, String, String)	Registers the hidden field to a page
Public method Static member	RegisterHiddenField(Page, String, String)	Registers the hidden field to a page
Public method Static member	RegisterJQuery	Ensures registration of jQuery JavaScript library.
Public method Static member	RegisterJQueryAppear	Ensures registration of jQuery appear JavaScript library.
Public method Static member	RegisterJQueryCookie	Ensures registration of jQuery cookie JavaScript library.
Public method Static member	RegisterJQueryCrop	Ensures registration of jQuery crop JavaScript library.
Public method Static member	RegisterJQueryDialog	Ensures registration of jQuery dialog.
Public method Static member	RegisterJQueryHighLighter	Ensures registration of jQuery highlighter JavaScript library.
Public method Static member	RegisterJQueryTemplates	Ensures registration of jQuery templates JavaScript library.
Public method Static member	RegisterJQueryTools	Ensures registration of jQuery tools JavaScript library.
Public method Static member	RegisterJQueryUI	Ensures registration of jQuery UI JavaScript library.
Public method Static member	RegisterJQueryUILayout	Registers jQuery UI layout library.
Public method Static member	RegisterLoader	Ensures the registration of the loader module
Public method Static member	RegisterModule	Renders JavaScript code to start a client-side module.
Public method Static member	RegisterMooTools	Ensures registration of MooTools JavaScript library.
Public method Static member	RegisterOnlyNumbersScript	Registers only numbers script for input fields.
Public method Static member	RegisterOnSubmitStatement	Registers the form submit statement.
Public method Static member	RegisterPageLoadedEvent	Registers a client script, that rises the PageLoaded event, with the Page object.
Public method Static member	RegisterPageLoadedFlag	Registers the script which identifies that page was loaded.
Public method Static member	RegisterPrintDialogScript	Registers script for printing dialog.
Public method Static member	RegisterRequireJs	Registers the require.js client script with the Page object.
Public method Static member	RegisterResizer	Ensures registration of the resizer script.
Public method Static member	RegisterRestoreFocusScript	Registers script capable of restoring focus when asynchronous postback is finished.
Public method Static member	RegisterSaveChanges	Ensures registration of the save changes notification script.
Public method Static member	RegisterSaveShortcut(Page, String)	Registers a script which when invoked via keyboard shortcut saves the document.
Public method Static member	RegisterSaveShortcut<T>(T, String, String)	Registers a control which when invoked via keyboard shortcut saves the document.
Public method Static member	RegisterScriptFile	Registers the client script and adds a script file reference to the page. Allows to explicitly disable script minification.
Public method Static member	RegisterScriptFromFile	Registers the client script and renders the script from file into the page.
Public method Static member	RegisterSetLiveSiteURL	Ensures registration of the update live site URL script for the application list.
Public method Static member	RegisterSpellChecker(Page)	Ensures registration of the spellchecker script.
Public method Static member	RegisterSpellChecker(Page, Boolean)	Ensures registration of the spellchecker script.
Public method Static member	RegisterSplitModeSync	Registers js script for synchronization scroll bars in split mode.
Public method Static member	RegisterStartupScript(Control, Type, String, String, Boolean)	Registers the startup script.
Public method Static member	RegisterStartupScript(Page, Type, String, String, Boolean)	Registers the startup script.
Public method Static member	RegisterTooltip	Ensures registration of tool tip script.
Public method Static member	RegisterTreeProgress	Ensures registration of the progress icon script for the tree.
Public method Static member	RegisterWebComponentsScript	Registers a client script, which is responsible for loading custom web components.
Public method Static member	RegisterWebServiceCallFunction	Registers helper function to call web services.
Public method Static member	RegisterWOpenerScript	Registers the script which checks the page completeness on postback.
Public method Static member	RenderAngularModulesScript	Renders JavaScript code to start a client-side angular modules.
Public method Static member	RequestScriptRegistration	Requests particular script registration. Returns true if the registration is allowed
Public method Static member	ResetScrollPosition	Reset scroll positions for current request if MaintainScrollPositionOnPostback is enabled
Public method Static member	ResolveUrl	Resolves URL to be used in javascript. Virtual context prefix needs to be ensured.
Public method Static member	SerializeModuleParametersToJson	Converts an object with client-side module parameters to a JSON string.