Contentserv PHP API

CSActiveScriptGui
in package

Gui API that provides several functions around the Graphical User Interface

Tags
since

CS16.1

access

public

Table of Contents

getHeight()  : int
Returns the required dialog height when used with the given amount of input fields
getJSForRunDialog()  : string
Creates javascript code, that opens the Run ActiveScript Window
getWatchJobUrl()  : string
Creates a URL that can be opened to watch a job in a stand alone browser window
getWidth()  : int
Returns the required dialog width when used with the given amount of input fields

Methods

getHeight()

Returns the required dialog height when used with the given amount of input fields

public static getHeight(int $iFieldCount) : int
Parameters
$iFieldCount : int

the number of fields the dialog should have

Tags
Return values
int —

the height in px

getJSForRunDialog()

Creates javascript code, that opens the Run ActiveScript Window

public static getJSForRunDialog(mixed $IDString[, string $class = 'Pdmarticle' ][, bool|false $bForPopUp = false ][, string $language = '' ][, mixed $iDefaultActiveScriptID = null ]) : string
Parameters
$IDString : mixed

ID or IDs as comma separated list or array

$class : string = 'Pdmarticle'

Class name or sample record

$bForPopUp : bool|false = false

Set to TRUE if the javascript code is for a popup action.

$language : string = ''
$iDefaultActiveScriptID : mixed = null
Tags
access

public

Return values
string —

string pure javascript code that can be used to open a run dialog

getWatchJobUrl()

Creates a URL that can be opened to watch a job in a stand alone browser window

public static getWatchJobUrl(int $iJobID[, bool $bShowMoreDetails = false ]) : string
Parameters
$iJobID : int

the ID of the job to watch

$bShowMoreDetails : bool = false

true if all log details should be visible

Tags
Return values
string —

getWidth()

Returns the required dialog width when used with the given amount of input fields

public static getWidth(int $iFieldCount) : int
Parameters
$iFieldCount : int

the number of fields the dialog should have

Tags
Return values
int —

the width in px


        

        
    




    

    

                

    

        

            
Search results