build
String  build

Returns the current version (major, minor, build)

Returns
String  build String

Supported Clients
SmartClient, WebClient, NGClient

buildDate
Date  buildDate

Returns date release date

Returns
Date  date Date

Supported Clients
SmartClient, WebClient, NGClient

component
String  component

Returns the component name

Returns
String  name String

Supported Clients
SmartClient, WebClient, NGClient

licensee
String  licensee

Returns the licensee

Returns
String  licensee String

Supported Clients
SmartClient, WebClient, NGClient

typeLicensed
String  typeLicensed

Returns the type that is valid for this license

Returns
String  type String

Supported Clients
SmartClient, WebClient, NGClient

version
Number  version

Returns the current version (major, minor)

Returns
Number  version Double

Supported Clients
SmartClient, WebClient, NGClient

versionLicensed
String  versionLicensed

Returns the version that is valid for this license

Returns
String  license String

Supported Clients
SmartClient, WebClient, NGClient

convertToAsposeDataTable
DataTable  convertToAsposeDataTable( JSDataSet, String )

Converts a Servoy DataSet to an Aspose DataTable

Parameters
JSDataSet  servoyDataSet  Servoy DataSet
String  mergeRegionName  Name for the merge region

Returns
DataTable  asposeDataTable

Supported Clients
SmartClient, WebClient, NGClient

Sample

var myDataSet = databaseManager.createEmptyDataSet();
var asposeDataTable = plugins.it2be_word.convertToAsposeDataTable(myDataSet, "MergeRegionName")

convertToAsposeDataTable
DataTable  convertToAsposeDataTable( FoundSet, String )

Converts a Servoy FoundSet to an Aspose DataTable

Parameters
FoundSet  servoyFoundSet  Servoy FoundSet
String  mergeRegionName  Name for the merge region

Returns
DataTable  asposeDataTable

Supported Clients
SmartClient, WebClient, NGClient

Sample

var asposeDataTable = plugins.it2be_word.convertToAsposeDataTable(foundset, "MergeRegionName")

createDocument
IWDocument  createDocument( )

Create an empty Document (See IWDocument)

Returns
IWDocument  document IWDocument

Supported Clients
SmartClient, WebClient, NGClient

Sample

/** @type {IWDocument} */
var vDocument = plugins.it2be_word.createDocument();

createDocument
IWDocument  createDocument( String )

Create an empty Document or create one based on a template (See IWDocument)

Parameters
String  templatePath  the template path

Returns
IWDocument  document IWDocument

Supported Clients
SmartClient, WebClient, NGClient

Sample

/** @type {IWDocument} */
var vDocument = plugins.it2be_word.createDocument("/path/to/template.dot(x)");

createLinqDataSource
LinqDataSource  createLinqDataSource( FoundSet )

Creates a new LINQ datasource from a FoundSet

Parameters
FoundSet  servoyFoundSet  Foundset to base the datasource off of

Returns
LinqDataSource  

Supported Clients
SmartClient, WebClient, NGClient

Sample

// Grab a foundset
var myFoundSet = datasources.db.example_data.getFoundSet();
myFoundSet.loadAllRecords();

// Convert it to a LINQ datasource
var linqDataSource = plugins.it2be_word.createLinqDataSource(myFoundSet);

createLinqDataSource
LinqDataSource  createLinqDataSource( FoundSet, String )

Creates a new LINQ datasource from a FoundSet, using a provided table alias.

Parameters
FoundSet  servoyFoundSet  Foundset to base the datasource off of
String  tableName  Table alias to be used in the template

Returns
LinqDataSource  

Supported Clients
SmartClient, WebClient, NGClient

Sample

// Grab a foundset
var myFoundSet = datasources.db.example_data.getFoundSet();
myFoundSet.loadAllRecords();

// Convert it to a LINQ datasource
var linqDataSource = plugins.it2be_word.createLinqDataSource(myFoundSet, "invoices");

createLinqJsonDataSource
LinqJsonDataSource  createLinqJsonDataSource( String, String, String )

Creates a new LINQ datasource from a JSON string, using the provided alias and date format.

Parameters
String  jsonDataSource  JSON string containing data to be used in the report
String  dataSourceName  Data alias to be used in the template
String  dateTimeFormat  Format to be used for dates derived from the JSON object

Returns
LinqJsonDataSource  

Supported Clients
SmartClient, WebClient, NGClient

Sample

// Create an object
var myData = {
data: "Test"
};

// Convert it to a JSON datasource, using "YYYY-MM-DD" format for all dates.
var jsonDataSource = plugins.it2be_word.createLinqJsonDataSource(JSON.stringify(myData), "params", "YYYY-MM-DD");

createLinqJsonDataSource
LinqJsonDataSource  createLinqJsonDataSource( String, String )

Creates a new LINQ datasource from a JSON string, using a provided alias.

Parameters
String  jsonDataSource  JSON string containing data to be used in the report
String  dataSourceName  Data alias to be used in the template

Returns
LinqJsonDataSource  

Supported Clients
SmartClient, WebClient, NGClient

Sample

// Create an object
var myData = {
data: "Test"
};

// Convert it to a JSON datasource
var jsonDataSource = plugins.it2be_word.createLinqJsonDataSource(JSON.stringify(myData), "params");

createLinqJsonDataSource
LinqJsonDataSource  createLinqJsonDataSource( String, String, String, String )

Creates a new LINQ datasource from a JSON string, using the provided alias, date format, and parsing mode.

Parameters
String  jsonDataSource  JSON string containing data to be used in the report
String  dataSourceName  Data alias to be used in the template
String  dateTimeFormat  Format to be used for dates derived from the JSON object
String  parseMode  Parsing mode for property values. Should be either "STRICT" or "LOOSE". In Strict Mode, values are determined from their type (for example, "123" is a string). In Loose mode, values are determined from their value (for example, "123" is a number).

Returns
LinqJsonDataSource  

Supported Clients
SmartClient, WebClient, NGClient

Sample

// Create an object
var myData = {
data: "Test"
};

// Convert it to a JSON datasource, using "YYYY-MM-DD" format for all dates.
var jsonDataSource = plugins.it2be_word.createLinqJsonDataSource(JSON.stringify(myData), "params", "YYYY-MM-DD");

openDocument
IWDocument  openDocument( String )

Open an existing Document (See IWDocument)

Parameters
String  originalPath  the original path

Returns
IWDocument  document IWDocument

Supported Clients
SmartClient, WebClient, NGClient

Sample

/** @type {IWDocument} */
var vDocument = openDocument("/path/to/document.doc(x)");

openDocument
IWDocument  openDocument( String, String )

Open an existing Document (See IWDocument)

Parameters
String  originalPath  the original path
String  password  the password

Returns
IWDocument  documentIWDocument

Supported Clients
SmartClient, WebClient, NGClient

Sample

/** @type {IWDocument} */
var vDocument = openDocument("/path/to/document.doc(x)");

register
Boolean  register( String )

Register your runtime license (use the Components Manager to request your license string)

Parameters
String  license  the license

Returns
Boolean  result boolean

Supported Clients
SmartClient, WebClient, NGClient

Sample

// You have to register your plug-in(s) and beans before you start using them
// One way to do so is create an 'onOpenSolution' method and add the 'register(.)' method(s) there
plugins.it2be_word.register("Insert the license string(s) from your '*_runtime_license.txt' file here!");