MeadCo.ScriptX

 $(window).on('load', function () {
   if ( MeadCo.ScriptX.Init() (
   {
      $("#info").text("ScriptX version: " + MeadCo.ScriptX.GetComponentVersion("scriptx.factory"));
      MeadCo.ScriptX.Printing.header =
       "MeadCo's ScriptX&b:&p of &P:&bBasic Printing Sample";
     MeadCo.ScriptX.Printing.footer =
       "The de facto standard for advanced web-based printing";
     MeadCo.ScriptX.Printing.orientation = "landscape";
     $("#btnprint").click(function() {
         MeadCo.ScriptX.PrintPage(false);
  }
});

if ( MeadCo.Licensing.IsLicensed() ) {
 	...
}
else {
   MeadCo.Licensing.ReportError();
}

Members

(static, readonly) Connector

The discovered connection - NONE, ADDON or SERVICE

Description:

• The discovered connection - NONE, ADDON or SERVICE

Source:

• meadco-scriptx.js, line 186

(static, constant) LibVersion

The semver version of this library

Description:

• The semver version of this library

Source:

• meadco-scriptx.js, line 193

Methods

(static) BackgroundPrintHTML(sHtml, fnCallbackopt, dataopt) → {boolean}

Background print the html document contained in the string.

Description:

• Background print the html document contained in the string. This is a wrapper on the PrintHtmlEX() API using html:// protocol.

  Note that processing after call is asynchronous. There is no Promise returning version as the function always returns true (there is no prompting). See MeadCo.ScriptX.WaitForSpoolingComplete() for how to implement synchronous coding.

Source:

• meadco-scriptx.js, line 691

See:

• PrintHtmlEX() API.

Parameters:

Returns:

Type

boolean

(static) BackgroundPrintURL(sUrl, bPromptopt, fnCallbackopt, dataopt) → {boolean}

Download and print an HTML document in the background.

Description:

• Download and print an HTML document in the background. This is a wrapper on the PrintHtmlEX() API.

Source:

• meadco-scriptx.js, line 628

Deprecated:

• from 1.4 as the return value will be wrong for service when using prompted printing since dialogs are async. Use BackgroundPrintURL2 if the return value matters

See:

• PrintHtmlEX() API.

Parameters:

Returns:

Type

boolean

(static) BackgroundPrintURL2(sUrl, bPromptopt, fnCallbackopt, dataopt) → {Promise}

Download and print an HTML document in the background.

Description:

• Download and print an HTML document in the background. This is a wrapper on the PrintHtmlEX() API.

Source:

• meadco-scriptx.js, line 653

See:

• PrintHtmlEX() API.

Parameters:

Returns:

Type

Promise

(static) CloseWindow(oWindow)

Ensures orderly closing of a window in ScriptX.Services by waiting for jobs to complete before the window closes.

Description:

• Ensures orderly closing of a window in ScriptX.Services by waiting for jobs to complete before the window closes. This is done automatically by ScriptX.Addon

Source:

• meadco-scriptx.js, line 898

Parameters:

(static) DirectPrintDocument(sPrinterName, sUrl)

Download content from a url and send its contents (e.g.

Description:

• Download content from a url and send its contents (e.g. ZPL) directly to the printer as a byte stream. This is a wrapper on the printDocument() API

Source:

• meadco-scriptx.js, line 728

See:

• printDocument() API

Parameters:

(static) DirectPrintString(sPrinterName, sData)

Directly print a stream of characters to a printer without formatting, pagination or any other processing.

Description:

• Directly print a stream of characters to a printer without formatting, pagination or any other processing. This is a wrapper on the printString() API

Source:

• meadco-scriptx.js, line 710

See:

• printString() API

Parameters:

(static) GetAvailablePrinters() → {Array.<string>}

Determnines the names of the printers available pon the device.

Description:

• Determnines the names of the printers available pon the device. This function wraps the EnumPrinters API in a more convenient form.

Source:

• meadco-scriptx.js, line 929

See:

• EnumPrinters API

Returns:

Type

Array.<string>

(static) GetComponentVersion(sComponent) → {string}

Returns the version of an installed component as a dotted version string.

Description:

• Returns the version of an installed component as a dotted version string. This wraps the deprecated API GetComponentVersion which is available with all versions of ScriptX. Use the recommended alternatives.

Source:

• meadco-scriptx.js, line 955

Deprecated:

• since v7 of ScriptX.Addon. Use ScriptX.Utils.ComponentVersionString or ScriptX.Utils.ScriptXVersion or ScriptX.Utils.SecurityManagerVersion

See:

• ComponentVersionString API
• ScriptXVersion API
• SecurityManagerVersion API

Parameters:

Returns:

Type

string

(static) HasOrientation() → {boolean}

Source:

• meadco-scriptx.js, line 916

Returns:

Type

boolean

(static) Init() → {boolean}

Performs synchronous initialisation by discovering and connecting to either ScriptX.Addon or the MeadCo ScriptX.Services Client Library emulation of the 'factory' object.

Description:

• Performs synchronous initialisation by discovering and connecting to either ScriptX.Addon or the MeadCo ScriptX.Services Client Library emulation of the 'factory' object.

  With ScriptX.Print Services this will use a synchronous (blocking, deprecated) call to the server.

  From v1.9.0 this function also initialises licensing when ScriptX.Services is being used by the browser to reduce required coding updates where MeadCo.ScriptX.Init() has been used.

Source:

• meadco-scriptx.js, line 283

See:

• MeadCo ScriptX.Services Client Library

Returns:

Type

boolean

(static) InitAsync() → {Promise}

Performs asynchronous initialisation by discovering and connecting to either ScriptX.Addon or ScriptX.Services.

Description:

• Performs asynchronous initialisation by discovering and connecting to either ScriptX.Addon or ScriptX.Services.

  From v1.9.0 this function also initialises licensing when ScriptX.Services is being used by the browser to reduce required coding updates where MeadCo.ScriptX.Init() has been used. To obtain the license read the property MeadCo.Licensing.LicMgr.License

Source:

• meadco-scriptx.js, line 332

Returns:

Type

Promise

(static) InitWithVersion(strVersion) → {boolean}

Initialises the library and ensures that the installed version is at least some version.

Description:

• Initialises the library and ensures that the installed version is at least some version. If ScriptX is available but not the required version an alert dialog is displayed.

Source:

• meadco-scriptx.js, line 395

Deprecated:

• from version 1.8.0

Parameters:

Returns:

Type

boolean

(static) IsComponentVersion(strComponentName, strVersionRequired) → {boolean}

Determine if the installed version of a COM component is at least the given version

Description:

• Determine if the installed version of a COM component is at least the given version

Source:

• meadco-scriptx.js, line 1006

Parameters:

Returns:

Type

boolean

(static) IsServices(strVersion) → {boolean}

Source:

• meadco-scriptx.js, line 435

Parameters:

Returns:

Type

boolean

(static) IsServicesVersion(strVersion) → {boolean}

Source:

• meadco-scriptx.js, line 480

Parameters:

Returns:

Type

boolean

(static) IsVersion(strVersion) → {boolean}

Source:

• meadco-scriptx.js, line 425

Parameters:

Returns:

Type

boolean

(static) PageSetup() → {boolean}

Invokes a Page Setup Dialog.

Description:

• Invokes a Page Setup Dialog. This is a wrapper on the PageSetup API

Source:

• meadco-scriptx.js, line 750

Deprecated:

• from 1.4 as the return value will be wrong for service since dialogs are async. Use PageSetup2 if the return value matters

See:

• PageSetup API
• PageSetup2

Returns:

Type

boolean

(static) PageSetup2() → {Promise}

Invokes a Page Setup Dialog.

Description:

• Invokes a Page Setup Dialog. This is a wrapper on the PageSetup API

Source:

• meadco-scriptx.js, line 784

See:

• PageSetup API

Returns:

Type

Promise

(static) PreviewPage()

Opens a preview of the printed current document (page).

Description:

• Opens a preview of the printed current document (page). This is a wrapper on the Preview() API.

Source:

• meadco-scriptx.js, line 549

See:

• Preview() API

(static) PreviewPage(frame)

Opens a preview of the printed frame.

Description:

• Opens a preview of the printed frame. This is a wrapper on the Preview() API.

Source:

• meadco-scriptx.js, line 606

See:

• Preview() API

Parameters:

(static) PrintFrame(frame, bPromptopt) → {boolean}

Print the content of the frame, with optional prompting (no prompt in the internetzone requires a license).

Description:

• Print the content of the frame, with optional prompting (no prompt in the internetzone requires a license). This is a wrapper on the Print API.

Source:

• meadco-scriptx.js, line 564

Deprecated:

• from 1.4 as the return value will be wrong for service when using prompted printing since dialogs are async. Use PrintFrame2 if the return value matters

See:

• Print API

Parameters:

Returns:

Type

boolean

(static) PrintFrame2(frame, bPromptopt) → {Promise}

Print the content of the frame, with optional prompting (no prompt in the internetzone requires a license).

Description:

• Print the content of the frame, with optional prompting (no prompt in the internetzone requires a license). This is a wrapper on the Print API.

Source:

• meadco-scriptx.js, line 580

See:

• Print API

Parameters:

Returns:

Type

Promise

(static) PrintPage(bPromptopt) → {boolean}

Print the current document, with optional prompting (no prompt in the internetzone requires a license).

Description:

• Print the current document, with optional prompting (no prompt in the internetzone requires a license). This is a wrapper on the Print API.

Source:

• meadco-scriptx.js, line 509

Deprecated:

• from 1.4 as the return value will be wrong for service since dialogs are async. Use PrintPage2 if the return value matters

See:

• Print API

Parameters:

Returns:

Type

boolean

(static) PrintPage2(bPromptopt) → {Promise}

Print the current document, with optional prompting (no prompt in the internetzone requires a license).

Description:

• Print the current document, with optional prompting (no prompt in the internetzone requires a license). This is a wrapper on the Print API.

Source:

• meadco-scriptx.js, line 524

See:

• Print API

Parameters:

Returns:

Type

Promise

(static) PrintSetup() → {boolean}

Invokes a Print Setup Dialog.

Description:

• Invokes a Print Setup Dialog. This is a wrapper on the PrintSetup API

Source:

• meadco-scriptx.js, line 765

Deprecated:

• from 1.4 as the return value will be wrong for service since dialogs are async. Use PrintSetup2 if the return value matters

See:

• PrintSetup API
• PrintSetup2

Returns:

Type

boolean

(static) PrintSetup2() → {Promise}

Invokes a Print Setup Dialog.

Description:

• Invokes a Print Setup Dialog. This is a wrapper on the PrintSetup API

Source:

• meadco-scriptx.js, line 820

See:

• PrintSetup API

Returns:

Type

Promise

(static) ScriptXVersion() → {string}

Get the installed version of ScriptX

Description:

• Get the installed version of ScriptX

Source:

• meadco-scriptx.js, line 986

Returns:

Type

string

(static) SecurityManagerVersion() → {string}

Get the installed version of MeadCo Security Manager

Description:

• Get the installed version of MeadCo Security Manager

Source:

• meadco-scriptx.js, line 996

Returns:

Type

string

(static) ServicesVersion() → {string}

If services is in use, returns the version of the services server.

Description:

• If services is in use, returns the version of the services server. If addon is in use returns ""

  Requires services 2.9 or later, earlier versions will return the client library version (1.x)

Source:

• meadco-scriptx.js, line 463

Returns:

Type

string

(static) SetContentAuthorisationCookie(strCookie)

With ScriptX.Addon, printHtml(Ex) and printPdf(Ex) inherit authorisation cookies from the hosting browser.

Description:

• With ScriptX.Addon, printHtml(Ex) and printPdf(Ex) inherit authorisation cookies from the hosting browser. This does not happen with ScriptX.Services and in modern uses the authorisation cookie is hidden from javascript so cannot be automated. The cookie must be exposed in the HTML and passed in with a call to this function.

Source:

• meadco-scriptx.js, line 494

Parameters:

(static) StartAsync(settings) → {Promise}

Perform full asynchronous initialisation - for services, connecting to a server, then for addon and services connecting to a secmgr implementation, checking for a license and connecting to factory and printing implementations.

Description:

• Perform full asynchronous initialisation - for services, connecting to a server, then for addon and services connecting to a secmgr implementation, checking for a license and connecting to factory and printing implementations.

  Lastly apply print settings as defined.

  This is the preferred library initialisation call especially when wishing to support working with ScriptX.Services as it a) ensures a license is available before attempting services calls and b) is asynchronous and c) hides a lot of code in a simple call.

Source:

• meadco-scriptx.js, line 199

Example

$(window).on('load', function () {
   MeadCo.ScriptX.StartAsync({
         serviceConnection: {
             serverUrl: "http://127.0.0.1:41191",
             licenseGuid: "{370000ED-D40C-43D4-B3D3-F2E7D2EFF47D}", // invalid example, use same as for addon
             licenseRevision: 0,
             licensePath: "warehouse"
         },
         printSettings: {
             header: "Page &p of &P",
             footer: "&D",
             pageSetup: {
                 orientation: "landscape"
             }              
         }
     })
     .then(function() {
         $("#btn-print").click(function() {
             MeadCo.ScriptX.PrintPage(false);
         });
     })
     .catch(function(e) {
         alert("An error occurred, printing will not be available.\n\n"+e);
     });

Parameters:

Returns:

Type

Promise

(static) Version() → {string}

Source:

• meadco-scriptx.js, line 414

Returns:

Type

string

(static) WaitForSpoolingComplete() → {Promise}

Waits for all pending spooling and download operations originated with Print, PrintHTML and BatchPrintPDF to complete.

Description:

• Waits for all pending spooling and download operations originated with Print, PrintHTML and BatchPrintPDF to complete. This is useful for providing 'busy' UI or waiting for all jobs to complete before closing a window.

  This is a wrapper on the common use (no arguments) of the WaitForSpoolingComplete API and returns a Promise so that it can work with both ScriptX.Addon and ScriptX.Services

Source:

• meadco-scriptx.js, line 864

See:

• WaitForSpoolingComplete API
• Working with ScriptX.Addon and ScriptX.Services
• ScriptX.Services Client Library

Example

MeadCo.ScriptX.PrintPage(false);
MeadCo.ScriptX.WaitForSpoolingComplete().finally(function(bAllJobsComplete) {
 self.close();
})

Returns:

Type

Promise

Type Definitions

Connection

Enum to describe the implementation being wrapped : .Addon or .Services

Description:

• Enum to describe the implementation being wrapped : .Addon or .Services

Source:

• meadco-scriptx.js, line 90

Properties:

Type:

• number

Margins

Source:

• meadco-scriptx.js, line 124

Properties:

MeasurementUnits

Enum to describe the units used on measurements.

Description:

• Enum to describe the units used on measurements. These values do match the values used by the MeadCo ScriptX COM Servers.

Source:

• meadco-scriptx.js, line 107

Properties:

Type:

• number

PageSetup

Describe pagesetup - orientation and the margins to use

Description:

• Describe pagesetup - orientation and the margins to use

Source:

• meadco-scriptx.js, line 134

Properties:

Type:

• Object

PrintSettings

Source:

• meadco-scriptx.js, line 145

Properties:

Type:

• Object

ServiceConnection

Source:

• meadco-scriptx.js, line 153

Properties:

Type:

• Object

StartupSettings

Source:

• meadco-scriptx.js, line 163

Properties:

Type:

• Object