The ScriptHelper type exposes the following members.
Back to Top
Back to Top
Back to Top
Methods
| Name | Description | |
|---|---|---|
  | AddScript |
Adds a script to an existing script
|
| AddToRegisteredClientScripts |
Adds key identifying script to collection of registered scripts.
|
| AddToRegisteredStartupScripts |
Adds key identifying script to collection of registered startup scripts.
|
| Alert |
Renders alert script to the page
|
| AppendTooltip(WebControl, String, String) |
Appends tooltip to control.
|
| AppendTooltip(HtmlGenericControl, String, String, Int32, Boolean) |
Appends tooltip to control.
|
| AppendTooltip(WebControl, String, String, Int32, Boolean) |
Appends tooltip to control.
|
| CloseWindow |
Generates the script to close the window and optionally refresh the opener content.
|
| EscapeHTMLString |
Escapes the given HTML string for usage in the JavaScript string constant.
|
| EscapeJQueryCharacters |
Escapes the given string for usage in the jQuery selectors. All meta-characters are escaped using '\'.
|
| FixPendingCallbacks |
Fixes common 'pendingCallbacks' JavaScript error.
|
| FormatTooltipString |
Formats string to be used for tooltip.
|
| GetAlertScript |
Returns the JavaScript alert message.
|
| GetDisableProgressScript |
Returns script to disable progress for a single following action.
|
| GetIncludeScript(String) |
Builds an HTML script tag that can be used to include external script given its URL.
|
| GetIncludeScript(String, Boolean) |
Builds an HTML script tag that can be used to include external script given its URL.
Allows to explicitly disable script minification.
|
| GetLoaderHtml |
Gets the HTML content of the standard system loader.
|
| GetLoaderInlineHtml |
Gets the HTML content of the standard system loader icon with specified text.
|
| GetLoaderOverlayHtml |
Gets the HTML content of the standard system loader overlay.
|
| GetLocalizedString(String) |
Localizes and encodes text to be used in JavaScript string and encapsulates it with "'".
|
| GetLocalizedString(String, Boolean) |
Localizes and encodes text to be used in JavaScript string and optionally encapsulates it with "'".
|
| GetModalDialogScript(String, String, Int32, Int32, Boolean) |
Returns script which opens modal dialog.
|
| GetModalDialogScript(String, String, String, String, Boolean) |
Returns script which opens modal dialog.
|
| GetRedirectScript |
Returns a script block that handles page redirection.
|
| GetScript |
Encloses the specified script in an HTML script element.
|
| GetScriptUrl |
Gets the URL used to retrieve external script file.
Allows to explicitly disable script minification.
|
| GetString(String) |
Encodes text to be used in JavaScript string and encapsulates it with "'".
|
| GetString(String, Boolean) |
Encodes text to be used in JavaScript string and optionally encapsulates it with "'".
|
| GetString(String, Boolean, Boolean) |
Encodes text to be used in JavaScript string and optionally encapsulates it with "'".
|
| GetTitleScript |
Gets the script for the automatic window title.
|
| HideVerticalTabs |
Hides the parent vertical tabs
|
| IsClientScriptBlockRegistered |
Returns whether client script with given key is already registered.
|
| IsJQueryRegistered |
Determines whether jQuery library is already registered.
|
| IsLightBoxRegistered |
Determines whether Lightbox is already registered.
|
| IsMooToolsRegistered |
Determines whether MooTools library is already registered.
|
| IsPrototypeBoxRegistered |
Determines whether Prototype is already registered.
|
| IsSilverlightRegistered |
Returns true if silverlight script is registered
|
| IsStartupScriptRegistered |
Returns whether startup script with given key is already registered.
|
| IsUnderscoreRegistered |
Determines whether Underscore JavaScript library is already registered.
|
| RefreshTabHeader |
Reload page header and select specified tab
|
| RefreshTree |
Registers refresh tree script for documents UI
|
| RegisterAngularApplication |
Renders JavaScript code to start a client-side application.
There can be only one angular application on each ASPX page.
|
| RegisterApplicationConstants |
Ensures registration of the application constants script. It provides constants applicationUrl, imagesUrl, isRTL.
|
| RegisterArrayDeclaration |
Ensures registration of the array declaration script.
|
| RegisterBootstrapScripts |
Ensures registration of Bootstrap JavaScript library.
|
| RegisterBootstrapTooltip |
Ensures registration of bootstrap tooltip script.
|
| RegisterClientApplication |
Registers a client script, that adds the client application state to the page, with the Page object.
|
| 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.
|
| 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.
|
| RegisterClientScriptInclude |
Registers the client script for AJAX and then adds a script file reference to the page.
Allows to explicitly disable script minification.
|
| RegisterCloseDialogScript |
Registers script for centralized dialog closing. (Contains functionality for refreshing opener window.)
|
| RegisterCMS |
Ensures registration of the main CMS script.
|
| RegisterCompletePageScript |
Registers the script which checks the page completeness on postback.
|
| RegisterDialogScript |
Registers the script for modal dialogs.
Provides function modalDialog(url, name, width, height, otherParams, noWopener).
|
| RegisterEditScript |
Registers cmsedit.js script to the page and ensures initialization
|
| RegisterFacebookJavascriptSDK |
Register Facebook JavaScript SDK
|
| RegisterFlatResize |
Ensures registration of script which causes correct resizing of uni flat selectors.
|
| RegisterGetTopScript |
Registers script for centralized retrieving of 'top' frame. (Useful for dialogs.)
|
| RegisterHeaderActionsShadowScript |
Registers script for shadow below header actions.
|
| RegisterHiddenField(Control, String, String) |
Registers the hidden field to a page
|
| RegisterHiddenField(Page, String, String) |
Registers the hidden field to a page
|
| RegisterImageLazyLoad |
Registers script for lazy load images.
|
| RegisterJQuery |
Ensures registration of jQuery JavaScript library.
|
| RegisterJQueryAppear |
Ensures registration of jQuery appear JavaScript library.
|
| RegisterJQueryCookie |
Ensures registration of jQuery cookie JavaScript library.
|
| RegisterJQueryCrop |
Ensures registration of jQuery crop JavaScript library.
|
| RegisterJQueryDialog |
Ensures registration of jQuery dialog.
|
| RegisterJQueryHighLighter |
Ensures registration of jQuery highlighter JavaScript library.
|
| RegisterJQueryShadow |
Ensures registration of jQuery dropshadow JavaScript library.
|
| RegisterJQueryTemplates |
Ensures registration of jQuery templates JavaScript library.
|
| RegisterJQueryTools |
Ensures registration of jQuery tools JavaScript library.
|
| RegisterJQueryTooltips |
Ensures registration of jQuery tooltips JavaScript library.
|
| RegisterJQueryUI |
Ensures registration of jQuery UI JavaScript library.
|
| RegisterJQueryUILayout |
Registers jQuery UI layout library.
|
| RegisterLightbox |
Ensures registration of all necessary JavaScript libraries for Lightbox functionality.
|
| RegisterLoader |
Ensures the registration of the loader module
|
| RegisterModule |
Renders JavaScript code to start a client-side module.
|
| RegisterMooTools |
Ensures registration of MooTools JavaScript library.
|
| RegisterOnlyNumbersScript |
Registers only numbers script for input fields.
|
| RegisterOnSubmitStatement |
Registers the form submit statement.
|
| RegisterPageLoadedEvent |
Registers a client script, that rises the PageLoaded event, with the Page object.
|
| RegisterPageLoadedFlag |
Registers the script which identifies that page was loaded.
|
| RegisterPrintDialogScript |
Registers script for printing dialog.
|
| RegisterPrototype |
Ensures registration of Prototype JavaScript framework.
|
| RegisterRequireJs |
Registers the require.js client script with the Page object.
|
| RegisterResizer |
Ensures registration of the resizer script.
|
| RegisterSaveChanges |
Ensures registration of the save changes notification script.
|
| RegisterSaveShortcut(Page, String) |
Registers a script which when invoked via keyboard shortcut saves the document.
|
| RegisterSaveShortcut T (T, String, String) |
Registers a control which when invoked via keyboard shortcut saves the document.
|
| RegisterScriptaculous |
Ensures registration of Scriptaculous (script.aculo.us) JavaScript library.
|
| RegisterScriptFile |
Registers the client script and adds a script file reference to the page.
Allows to explicitly disable script minification.
|
| RegisterScriptFromFile |
Registers the client script and renders the script from file into the page.
|
| RegisterSilverlight |
Registers Silverlight's support script.
(http://code.msdn.microsoft.com/silverlightjs)
|
| RegisterSKMenu(Page) |
Ensures registration of SKMenu JavaScript support.
|
| RegisterSKMenu(Page, String) | Obsolete.
Ensures registration of SKMenu JavaScript support.
|
| RegisterSpellChecker(Page) |
Ensures registration of the spellchecker script.
|
| RegisterSpellChecker(Page, Boolean) |
Ensures registration of the spellchecker script.
|
| RegisterSplitModeSync |
Registers js script for synchronization scroll bars in split mode.
|
| RegisterStartupScript(Control, Type, String, String, Boolean) |
Registers the startup script.
|
| RegisterStartupScript(Page, Type, String, String, Boolean) |
Registers the startup script.
|
| RegisterTooltip |
Ensures registration of tool tip script.
|
| RegisterTreeProgress |
Ensures registration of the progress icon script for the tree.
|
| RegisterUnderscore |
Ensures registration of Underscore JavaScript library.
|
| RegisterWebServiceCallFunction |
Registers helper function to call web services.
|
| RegisterWOpenerScript |
Registers the script which checks the page completeness on postback.
|
| RequestScriptRegistration |
Requests particular script registration. Returns true if the registration is allowed
|
| ResetScrollPosition |
Reset scroll positions for current request if MaintainScrollPositionOnPostback is enabled
|
| ResolveUrl |
Resolves URL to be used in javascript. Virtual context prefix needs to be ensured.
|
| SerializeModuleParametersToJson |
Converts an object with client-side module parameters to a JSON string.
|
Fields
| Name | Description | |
|---|---|---|
 | BOOTSTRAP_CUSTOM_FILENAME |
Filename of custom bootstrap library.
|
| BOOTSTRAP_FILENAME |
Filename of bootstrap library.
|
| CLOSE_DIALOG_SCRIPT_KEY |
Script registration key for centralized dialog closing.
|
| DIALOG_SCRIPT_KEY |
Script registration key for the dialog script.
|
| EDIT_DOCUMENT_SCRIPT_KEY |
Edit document script key.
|
| GET_TOP_SCRIPT_KEY |
Script registration key for centralized retrieving of 'top' frame.
|
| JQUERY_FILENAME |
Filename of jquery library
|
| JQUERY_KEY |
Script registration key for jQuery JavaScript library.
|
| LIGHTBOX_KEY |
Script registration key for Lightbox.
|
| MOOTOOLS_FILENAME |
Filename of MooTools library.
|
| MOOTOOLS_KEY |
Script registration key for mootools JavaScript library.
|
| NEWWINDOW_SCRIPT_KEY |
Script registration key for the non modal win script.
|
| PROTOTYPE_FILENAME |
Script file for Prototype JavaScript library.
|
| PROTOTYPE_KEY |
Script registration key for Prototype JavaScript library.
|
| SAVE_DOCUMENT_SCRIPT_KEY |
Save document script key.
|
| SCRIPTFILE_PREFIX_KEY |
Prefix used for registering script files.
|
| SILVERLIGHT_FILENAME |
Silverlight script file
|
| SILVERLIGHT_KEY |
Script registration key for Silverlight script.
|
| TOOLBAR_SCRIPT_KEY |
Script registration key for the editor toolbar.
|
| TOOLTIP_SCRIPT_FILE_KEY |
Script registration key for tooltip file.
|
| UNDERSCORE_FILENAME |
Filename of Underscore library.
|
| UNDERSCORE_KEY |
Script registration key for Underscore library.
|
| WOPENER_SCRIPT_KEY |
Script registration key for cross-window scripting ("wopener").
|
Properties
| Name | Description | |
|---|---|---|
 | AllowProgressScript |
If true, progress script is allowed on pages.
|
| CapslockScript |
Capslock check script (OnCasplockOn and OnCapslockOff functions must be implemented).
|
| CloseDialogScript |
Script for centralized dialog closing.
|
| GetTopScript |
Script for centralized retrieving of 'top' frame.
|
| MinifyCurrentRequestScripts |
If true, the scripts in current request are minified.
|
| NewWindowScript |
Script code for the dialog handling.
|
| OnlyNumbersScript |
Only numbers script (Must be implemented in OnKeyDown event).
|
| ScriptMinificationEnabled |
Gets if script minification is enabled.
|
| ToolbarScript |
HTML Editor toolbar script.
|
| WOpenerScript |
Cross-window scripting script ("wopener").
|
See Also