• Api Documentation
Show / Hide Table of Contents
  • Softadmin.Api
    • AdminMessageException
    • CustomComponent
    • ICookies
    • ICredentialsStore
    • IEnvironment
    • IForwardState
    • IHttpHeaders
    • IParameters
    • ISessionVariables
    • ISystemSettings
    • Plugin
  • Softadmin.Api.Database
    • IDbRequest
    • IDbRequestFactory
  • Softadmin.Api.Diagnostics
    • ILogger
  • Softadmin.Api.Login
    • IUserState
    • LoginPlugin
    • PostLoginPlugin
    • PreLoginPlugin
    • UserAuthenticationPlugin
  • Softadmin.Api.Logout
    • LogoutPlugin
  • Softadmin.Api.Page
    • ICustomPage
    • PagePlugin
  • Softadmin.Api.Ui
    • IDebugWindow
    • IProgressWindow

Interface ICustomPage

Use to customize the scripts on a page.

Namespace: Softadmin.Api.Page
Assembly: Softadmin.Api.dll
Syntax
public interface ICustomPage

Methods

AddOnReadyScript(String)

Adds a script to execute when the page has been loaded.

Declaration
void AddOnReadyScript(string script)
Parameters
Type Name Description
System.String script
Remarks

Scripts are not guaranteed to be executed in the same order that they are added. The script should not be surrounded by <script> tags.

AddScriptDeclaration(String)

Adds a script declaration (either a function or a global variable) to the page.

Declaration
void AddScriptDeclaration(string script)
Parameters
Type Name Description
System.String script
Remarks

Add code that should be executed directly with AddOnReadyScript(String). The script should not be surrounded by <script> tags.

AddScriptFileImport(String)

Adds an URLs to a script file to include on the page.

Declaration
void AddScriptFileImport(string url)
Parameters
Type Name Description
System.String url
Remarks

Prefix URLs with ~/ to make them relative to the project root.

In This Article
Back to top Generated by DocFX