Show debugging output for missing bookmarks.

Get/Set the textFont for the rest of the document.

// Get/Set the textFont for the rest of the document.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vSamplePath + "/Bookmarks.dot" );
var vInsertion = plugins.it2be_word.openDocument( vSamplePath + "/Insertion.doc" );

//go to the selected bookmark, insert object and remove bookmark
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.gotoBookmark( "date" );
vDocument.textFont = "Courier,2,12";
vDocument.fontColor = "#ff0000";
vDocument.insertText( text );
vDocument.removeBookmark( "date" );

vDocument.gotoBookmark( "company_name" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "IT2BE" );
vDocument.removeBookmark( "company_name" );

vDocument.gotoBookmark( "fullname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel Trapman" );
vDocument.removeBookmark( "fullname" );

vDocument.gotoBookmark( "fax_direct" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "+31 847 44 36 75" );
vDocument.removeBookmark( "fax_direct" );

vDocument.gotoBookmark( "firstname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel," );
vDocument.removeBookmark( "firstname" );

vDocument.gotoBookmark( "body" );
vDocument.insertDocument( vInsertion )
vDocument.insertText( "Use the replaceBookmarks(vDataSet) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.removeBookmark( "body" );

vDocument.removeBookmark( "company_logo" );

vDocument.gotoBookmark( "user" );
vDocument.insertText( "security.getUserName()" );
vDocument.removeBookmark( "user" );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Get/Set the textFont color for the rest of the document.

// Get/Set the textFont for the rest of the document.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vSamplePath + "/Bookmarks.dot" );
var vInsertion = plugins.it2be_word.openDocument( vSamplePath + "/Insertion.doc" );

//go to the selected bookmark, insert object and remove bookmark
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.gotoBookmark( "date" );
vDocument.textFont = "Courier,2,12";
vDocument.fontColor = "#ff0000";
vDocument.insertText( text );
vDocument.removeBookmark( "date" );

vDocument.gotoBookmark( "company_name" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "IT2BE" );
vDocument.removeBookmark( "company_name" );

vDocument.gotoBookmark( "fullname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel Trapman" );
vDocument.removeBookmark( "fullname" );

vDocument.gotoBookmark( "fax_direct" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "+31 847 44 36 75" );
vDocument.removeBookmark( "fax_direct" );

vDocument.gotoBookmark( "firstname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel," );
vDocument.removeBookmark( "firstname" );

vDocument.gotoBookmark( "body" );
vDocument.insertDocument( vInsertion )
vDocument.insertText( "Use the replaceBookmarks(vDataSet) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.removeBookmark( "body" );

vDocument.removeBookmark( "company_logo" );

vDocument.gotoBookmark( "user" );
vDocument.insertText( "security.getUserName()" );
vDocument.removeBookmark( "user" );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Get/Set the textFont kerning for the rest of the document.

Get/Set the textFont spacing

Get/Set to keep source formatting for the imported text

Get/Set to the current style for the imported text

Specifies whether paragraphs that contained mail merge fields with no data should be removed from the document. When this option is set, paragraphs which contain region start and end merge fields which are otherwise empty are also removed.

Specifies whether unused merge fields should be removed from the document.

Surpress blank lines from the mailmerge

Append a document to the current document

Append a document to the current document

Append a document to the current document

Append a document to the current document

Clone a document

Convert a JSDataSet to a FormattedDataSet

Create a chart

/** @type {plugins.it2be_word.IWDocument} */
var vDocument;
/** @type {plugins.it2be_word.IWChart} */
var vChart;
/** @type {plugins.it2be_word.IWChartSeries} */
var vChartSeries;
/** @type {Array<String>} */
var vCategories;

// Create the Word document
vDocument = plugins.it2be_word.createDocument( );

// Create the chart
vChart = vDocument.createChart( plugins.it2be_word.CHART_TYPE.LINE, 432, 252 );

// Create an array with ALL the categories you want to set
vCategories = [ "AW Category 1", "AW Category 2" ];

// Adding new series.
// Arrays must not be empty and arrays must be the same size.
vChart.addCategories( "AW Series 1", vCategories, [ 1, 2 ] );
vChart.addCategories( "AW Series 2", vCategories, [ 3, 4 ] );
vChart.addCategories( "AW Series 3", vCategories, [ 5, 6 ] );
vChartSeries = vChart.addCategories( "AW Series 4", vCategories, [ 7, 8 ] );

vChartSeries.smooth = true;

// Move to the start of the document
vDocument.gotoStart( );

// Insert the chart now
vDocument.insertChart( vChart );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
vDocument.save( plugins.file.getDesktopFolder( ) + "/it2be-word.docx" );

Create a table for the document using an Array or a (Formatted) DataSet and an optional custom header array.

/** @type {plugins.it2be_word.IWDocument} */
var vDocument;
/** @type {plugins.it2be_word.IWTable} */
var vTable;
/** @type {Array<Object>} */
var vSet;
/** @type {Array<String>} */
var vHeader;

// Create the Word document
vDocument = plugins.it2be_word.createDocument( );

// Create the header
vHeader = [ "first name", "middle name","last name" ];

// Create the set
vSet = [ [ "Jan", "", "Aleman" ], [ "Bob", "", "Cusick" ], [ "Johan", "", "Compagner" ], [ "Ron", "van der", "Burg" ] ];

// Create the table
vTable = vDocument.createTable(vSet, vHeader);

// Move to the start of the document
vDocument.gotoStart( );

// Insert the table now
vDocument.insertTable( vTable );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
vDocument.save( plugins.file.getDesktopFolder( ) + "/it2be-word.docx" );

Create a table for the document using an Array or a (Formatted) DataSet and an optional custom header array.

/** @type {plugins.it2be_word.IWDocument} */
var vDocument;
/** @type {plugins.it2be_word.IWTable} */
var vTable;
/** @type {Array<Object>} */
var vSet;
/** @type {Array<String>} */
var vHeader;

// Create the Word document
vDocument = plugins.it2be_word.createDocument( );

// Create the header
vHeader = [ "first name", "middle name","last name" ];

// Create the set
vSet = [ [ "Jan", "", "Aleman" ], [ "Bob", "", "Cusick" ], [ "Johan", "", "Compagner" ], [ "Ron", "van der", "Burg" ] ];

// Create the table
vTable = vDocument.createTable(vSet, vHeader);

// Move to the start of the document
vDocument.gotoStart( );

// Insert the table now
vDocument.insertTable( vTable );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
vDocument.save( plugins.file.getDesktopFolder( ) + "/it2be-word.docx" );

Returns an array with all the bookmarks (names and text) available.

// Retrieve all bookmarks
var bookmarks = vDocument.getBookmarks();
var bookmark;
var index;

// Loop through your bookmarks
for (index = 0 ; index < bookmarks.length ; index++) {
bookmark = bookmarks[index];

// When using the IWBookmark like this the name (String value) is returned
application.output(bookmark);

// Or use the IWBookmark.getName() and IWBookmark.getText() methods
application.output(bookmark.getName());
application.output(bookmark.getText());

TODO create description

Get the textFont size

Get the names of the mail merge fields

Go to the bookmark by name.

// Go to the bookmark by name.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vSamplePath + "/Bookmarks.dot" );
var vInsertion = plugins.it2be_word.openDocument( vSamplePath + "/Insertion.doc" );

//go to the selected bookmark, insert object and remove bookmark
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.gotoBookmark( "date" );
vDocument.textFont = "Courier,2,12";
vDocument.fontColor = "#ff0000";
vDocument.insertText( text );
vDocument.removeBookmark( "date" );

vDocument.gotoBookmark( "company_name" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "IT2BE" );
vDocument.removeBookmark( "company_name" );

vDocument.gotoBookmark( "fullname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel Trapman" );
vDocument.removeBookmark( "fullname" );

vDocument.gotoBookmark( "fax_direct" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "+31 847 44 36 75" );
vDocument.removeBookmark( "fax_direct" );

vDocument.gotoBookmark( "firstname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel," );
vDocument.removeBookmark( "firstname" );

vDocument.gotoBookmark( "body" );
vDocument.insertDocument( vInsertion )
vDocument.insertText( "Use the replaceBookmarks(vDataSet) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.removeBookmark( "body" );

vDocument.removeBookmark( "company_logo" );

vDocument.gotoBookmark( "user" );
vDocument.insertText( "security.getUserName()" );
vDocument.removeBookmark( "user" );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Go to the end of the document.

Go to the beginning of the document.

Insert the alignment for the rest of the document.

Insert a bookmark at the selected position.

Insert an OOXML chart (limited to document types supporting this type of chart)

/** @type {plugins.it2be_word.IWDocument} */
var vDocument;
/** @type {plugins.it2be_word.IWChart} */
var vChart;
/** @type {plugins.it2be_word.IWChartSeries} */
var vChartSeries;
/** @type {Array<String>} */
var vCategories;

// Create the Word document
vDocument = plugins.it2be_word.createDocument( );

// Create the chart
vChart = vDocument.createChart( plugins.it2be_word.CHART_TYPE.LINE, 432, 252 );

// Create an array with ALL the categories you want to set
vCategories = [ "AW Category 1", "AW Category 2" ];

// Adding new series.
// Arrays must not be empty and arrays must be the same size.
vChart.addCategories( "AW Series 1", vCategories, [ 1, 2 ] );
vChart.addCategories( "AW Series 2", vCategories, [ 3, 4 ] );
vChart.addCategories( "AW Series 3", vCategories, [ 5, 6 ] );
vChartSeries = vChart.addCategories( "AW Series 4", vCategories, [ 7, 8 ] );

vChartSeries.smooth = true;

// Move to the start of the document
vDocument.gotoStart( );

// Insert the chart now
vDocument.insertChart( vChart );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
vDocument.save( plugins.file.getDesktopFolder( ) + "/it2be-word.docx" );

Insert a checkbox at the selected position by name, value and size.

Insert a Document to the existing document (created with createDocument(.) or openDocument(...)...

// Insert a Document to the existing document (created with createDocument(.) or openDocument(...)...
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vSamplePath + "/Bookmarks.dot" );
var vInsertion = plugins.it2be_word.openDocument( vSamplePath + "/Insertion.doc" );

//go to the selected bookmark, insert object and remove bookmark
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.gotoBookmark( "date" );
vDocument.textFont = "Courier,2,12";
vDocument.fontColor = "#ff0000";
vDocument.insertText( text );
vDocument.removeBookmark( "date" );

vDocument.gotoBookmark( "company_name" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "IT2BE" );
vDocument.removeBookmark( "company_name" );

vDocument.gotoBookmark( "fullname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel Trapman" );
vDocument.removeBookmark( "fullname" );

vDocument.gotoBookmark( "fax_direct" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "+31 847 44 36 75" );
vDocument.removeBookmark( "fax_direct" );

vDocument.gotoBookmark( "firstname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel," );
vDocument.removeBookmark( "firstname" );

vDocument.gotoBookmark( "body" );
vDocument.insertDocument( vInsertion )
vDocument.insertText( "Use the replaceBookmarks(vDataSet) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.removeBookmark( "body" );

vDocument.removeBookmark( "company_logo" );

vDocument.gotoBookmark( "user" );
vDocument.insertText( "security.getUserName()" );
vDocument.removeBookmark( "user" );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Insert a Document to the existing document (created with createDocument(.) or openDocument(...)...

// Insert a Document to the existing document (created with createDocument(.) or openDocument(...)...
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vSamplePath + "/Bookmarks.dot" );
var vInsertion = plugins.it2be_word.openDocument( vSamplePath + "/Insertion.doc" );

//go to the selected bookmark, insert object and remove bookmark
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.gotoBookmark( "date" );
vDocument.textFont = "Courier,2,12";
vDocument.fontColor = "#ff0000";
vDocument.insertText( text );
vDocument.removeBookmark( "date" );

vDocument.gotoBookmark( "company_name" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "IT2BE" );
vDocument.removeBookmark( "company_name" );

vDocument.gotoBookmark( "fullname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel Trapman" );
vDocument.removeBookmark( "fullname" );

vDocument.gotoBookmark( "fax_direct" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "+31 847 44 36 75" );
vDocument.removeBookmark( "fax_direct" );

vDocument.gotoBookmark( "firstname" );
vDocument.textFont = "Courier,2,12";
vDocument.insertText( "Marcel," );
vDocument.removeBookmark( "firstname" );

vDocument.gotoBookmark( "body" );
vDocument.insertDocument( vInsertion )
vDocument.insertText( "Use the replaceBookmarks(vDataSet) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.removeBookmark( "body" );

vDocument.removeBookmark( "company_logo" );

vDocument.gotoBookmark( "user" );
vDocument.insertText( "security.getUserName()" );
vDocument.removeBookmark( "user" );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Insert a field at the selected position.

Insert a html string at the selected position.

Insert an image (by path or media type) at the selected position (optional width and height pixels (int) or percentage (string).

Insert an image (by path or media type) at the selected position (optional width and height pixels (int) or percentage (string).

Insert an image (by path or media type) at the selected position (optional width and height pixels (int) or percentage (string).

Insert a mail merge field at the selected position.

Insert a pagebreak at the selected position.

Insert a Style Identifier to set a style for the rest of the document.

Insert a table at the selected position.

/** @type {plugins.it2be_word.IWDocument} */
var vDocument;
/** @type {plugins.it2be_word.IWTable} */
var vTable;
/** @type {Array<Object>} */
var vSet;
/** @type {Array<String>} */
var vHeader;

// Create the Word document
vDocument = plugins.it2be_word.createDocument( );

// Create the header
vHeader = [ "first name", "middle name","last name" ];

// Create the set
vSet = [ [ "Jan", "", "Aleman" ], [ "Bob", "", "Cusick" ], [ "Johan", "", "Compagner" ], [ "Ron", "van der", "Burg" ] ];

// Create the table
vTable = vDocument.createTable(vSet, vHeader);

// Move to the start of the document
vDocument.gotoStart( );

// Insert the table now
vDocument.insertTable( vTable );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
vDocument.save( plugins.file.getDesktopFolder( ) + "/it2be-word.docx" );

Inserts a TOC (table of contents) field into the document.

// This method inserts a TOC (table of contents) field into the document at
// the current position.
// A table of contents in a Word document can be built in a number of ways
// and formatted using a variety of options. The way the table is built and
// displayed by Microsoft Word is controlled by the field switches.
// The easiest way to specify the switches is to insert and configure a table of
// contents into a Word document using the Insert->Reference->Index and Tables menu,
// then switch display of field codes on to see the switches. You can press Alt+F9 in
// Microsoft Word to toggle display of field codes on or off.
// If you insert a table of contents using this method and then open the file
// in Microsoft Word, you will not see the table of contents because the TOC field
// has not yet been updated.
// In Microsoft Word, fields are not automatically updated when a document is opened,
// but you can update fields in a document at any time by pressing F9.

Insert text at the selected position.

Mailmerge the document with a Dataset or Foundset.

// Mailmerge the document with a Dataset or Foundset.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Create a dataset
var vQuery = "SELECT * FROM it2be_companies c, it2be_contacts o WHERE c.it2be_companiesid=o.it2be_companiesid";
var vDataSet = databaseManager.getDataSetByQuery( databaseManager.getDataSourceServerName( controller.getDataSource( ) ), vQuery, null, -1 );

// Stop executing this method when the record is empty and show an error dialog
if ( !vDataSet || vDataSet.getMaxRowIndex( ) == 0 ) {
plugins.dialogs.showErrorDialog( "Error.", "There are no records!", "OK" );
Return;
}

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Define the path to the original
// The path name should ALWAYS be the complete absolute path
var vOriginal = vSamplePath + "/Mailmerge.dot";

// Create the Word document with the selected original
// When you use images you need to set the field type to Image (prefix the name with 'Image:')
var vDocument = plugins.it2be_word.openDocument( vOriginal );

// Replace the 'generic' bookmarks
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.replaceBookmark( "body", "This is a mail merge sample.

There is nothing more to it than creating a template with merge-fields:" );
vDocument.replaceBookmark( "date", text );
vDocument.replaceBookmark( "user", "security.getUserName()" );

// Mailmerge the document with a foundset or dataset
vDocument.mailMerge( vDataSet );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

Mailmerge the document with regions.

// Mailmerge the document with regions.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Create a dataset
var vQuery = "SELECT * FROM it2be_companies c, it2be_contacts o WHERE c.it2be_companiesid=o.it2be_companiesid";
var vDataSet = databaseManager.getDataSetByQuery( databaseManager.getDataSourceServerName( controller.getDataSource( ) ), vQuery, null, -1 );

// Create an Aspose DataTable from the dataset
var vAsposeTable = plugins.it2be_word.convertToAsposeDataTable(vDataSet, "MyDataSet"); // Note: The second argument in this call must match the name of the merge region in the Word document.

// Stop executing this method when the record is empty and show an error dialog
if ( !vDataSet || vDataSet.getMaxRowIndex( ) == 0 ) {
plugins.dialogs.showErrorDialog( "Error.", "There are no records!", "OK" );
Return;
}

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Define the path to the original
// The path name should ALWAYS be the complete absolute path
var vOriginal = vSamplePath + "/Mailmerge.dot";

// Create the Word document with the selected original
// When you use images you need to set the field type to Image (prefix the name with 'Image:')
var vDocument = plugins.it2be_word.openDocument( vOriginal );

// Replace the 'generic' bookmarks
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.replaceBookmark( "body", "This is a mail merge sample.

There is nothing more to it than creating a template with merge-fields:" );
vDocument.replaceBookmark( "date", text );
vDocument.replaceBookmark( "user", "security.getUserName()" );

// Mailmerge the document with regions with a foundset or dataset
vDocument.mailMergeRegions( vAsposeTable );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.docx";
vDocument.save( vDocumentPath );

TODO create description

TODO create description

TODO create description

TODO create description

Create a footer for the first page after moving.

Create a footer for the first page after moving.

Create a header for the first page after moving.

Create a header for the first page after moving.

Create a footer for all pages after moving.

Create a footer for all pages after moving.

Create a header for all pages after moving.

Create a header for all pages after moving.

Remove the bookmark by name.

Replace the named bookmark with the entered text.

// Replace the bookmarks with the columnnames and row values (arrays), dataset, foundset or record.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Create a dataset
var vQuery = "SELECT c.companyname AS company_name,o.firstname,o.lastname,o.fullname,o.fax_direct FROM it2be_companies c, it2be_contacts o WHERE c.it2be_companiesid=o.it2be_companiesid";
var vDataSet = databaseManager.getDataSetByQuery( databaseManager.getDataSourceServerName( controller.getDataSource( ) ), vQuery, null, -1 );

// Stop executing this method when the record is empty and show an error dialog
if ( !vDataSet || vDataSet.getMaxRowIndex( ) == 0 ) {
plugins.dialogs.showErrorDialog( "Error.", "There are no records!", "OK" );
Return;
}

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Define the path to the original
// The path name should ALWAYS be the complete absolute path
var vOriginal = vSamplePath + "/Bookmarks.dot";

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vOriginal );

// When you want to be notified (in the log file) of missing bookmarks
// you should set the debugMissingBookmarks property
// IMPORTANT always place the method BEFORE processing your bookmarks
vDocument.debugMissingBookmarks = true;

// Replace the 'generic' bookmarks
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.replaceBookmark( "body", "Use the replaceBookmarks(dataset) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.replaceBookmark( "date", text );
vDocument.replaceBookmark( "user", "security.getUserName()" );

// Replace the bookmarks based on the names of the columns in the record
vDocument.replaceBookmarks( vDataSet );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.doc";
vDocument.save( vDocumentPath );

Replace the named bookmark with a checkbox by name, value and size.

Replace the named bookmark with an image.

Replace the named bookmark with an image.

Replace the named bookmark with a page break.

Replace the named bookmark with a table.

Replace the bookmarks with the columnnames and row values (arrays), dataset, foundset or record.

// Replace the bookmarks with the columnnames and row values (arrays), dataset, foundset or record.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Create a dataset
var vQuery = "SELECT c.companyname AS company_name,o.firstname,o.lastname,o.fullname,o.fax_direct FROM it2be_companies c, it2be_contacts o WHERE c.it2be_companiesid=o.it2be_companiesid";
var vDataSet = databaseManager.getDataSetByQuery( databaseManager.getDataSourceServerName( controller.getDataSource( ) ), vQuery, null, -1 );

// Stop executing this method when the record is empty and show an error dialog
if ( !vDataSet || vDataSet.getMaxRowIndex( ) == 0 ) {
plugins.dialogs.showErrorDialog( "Error.", "There are no records!", "OK" );
Return;
}

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Define the path to the original
// The path name should ALWAYS be the complete absolute path
var vOriginal = vSamplePath + "/Bookmarks.dot";

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vOriginal );

// When you want to be notified (in the log file) of missing bookmarks
// you should set the debugMissingBookmarks property
// IMPORTANT always place the method BEFORE processing your bookmarks
vDocument.debugMissingBookmarks = true;

// Replace the 'generic' bookmarks
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.replaceBookmark( "body", "Use the replaceBookmarks(dataset) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.replaceBookmark( "date", text );
vDocument.replaceBookmark( "user", "security.getUserName()" );

// Replace the bookmarks based on the names of the columns in the record
vDocument.replaceBookmarks( vDataSet );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.doc";
vDocument.save( vDocumentPath );

Replace the bookmarks with the columnnames and row values (arrays), dataset, foundset or record.

// Replace the bookmarks with the columnnames and row values (arrays), dataset, foundset or record.
// Important: Sample documents are stored in a server folder but your (smart) client needs locally stored documents!

// Create a dataset
var vQuery = "SELECT c.companyname AS company_name,o.firstname,o.lastname,o.fullname,o.fax_direct FROM it2be_companies c, it2be_contacts o WHERE c.it2be_companiesid=o.it2be_companiesid";
var vDataSet = databaseManager.getDataSetByQuery( databaseManager.getDataSourceServerName( controller.getDataSource( ) ), vQuery, null, -1 );

// Stop executing this method when the record is empty and show an error dialog
if ( !vDataSet || vDataSet.getMaxRowIndex( ) == 0 ) {
plugins.dialogs.showErrorDialog( "Error.", "There are no records!", "OK" );
Return;
}

// Sample documents are stored in the application_server/docs folder
var vSamplePath = "../application_server/docs/it2be-word";
if ( application.getOSName( ).indexOf( "Mac" ) > -1 ) {
vSamplePath = "../../../" + vSamplePath;
}

// Define the path to the original
// The path name should ALWAYS be the complete absolute path
var vOriginal = vSamplePath + "/Bookmarks.dot";

// Create the Word document with the selected original
var vDocument = plugins.it2be_word.openDocument( vOriginal );

// When you want to be notified (in the log file) of missing bookmarks
// you should set the debugMissingBookmarks property
// IMPORTANT always place the method BEFORE processing your bookmarks
vDocument.debugMissingBookmarks = true;

// Replace the 'generic' bookmarks
/** @type {String} */
var text = utils.dateFormat( new Date( ), i18n.getDefaultDateFormat( ) );

vDocument.replaceBookmark( "body", "Use the replaceBookmarks(dataset) method to replace the bookmarks found in the sample document.

To create bookmarks you should follow the below steps:" );
vDocument.replaceBookmark( "date", text );
vDocument.replaceBookmark( "user", "security.getUserName()" );

// Replace the bookmarks based on the names of the columns in the record
vDocument.replaceBookmarks( vDataSet );

// Define where and under what name you want the save the new file
// the path name should ALWAYS be the complete absolute path
// by adding the extension or the document type you also set the format (default is .docx)
// available formats/extensions are .doc, .docx, .txt and .html
var vDocumentPath = plugins.file.getDesktopFolder( ) + "/it2be-word.doc";
vDocument.save( vDocumentPath );

Replace a given regular expression with a new string value.

Replace a given string with a new string value.

Replace a given tag with a a new value (tags should be the same as field names).

Replace a given tag with a a new value (tags should be the same as field names).

Save the document with the pathname and overwrite the extension in the file path.

Save the document with the pathname and document type.

Save the document with the pathname, document type and password.

Save the document with the pathname and password.

Save the document with the pathname, document type, password and overwrite the extension in the file path.

Save the document with the pathname, password and overwrite the extension in the file path.

Save the document with the pathname.

Set author property of the document.

(Un)Check the checkbox

Set comments property of the document.

Set company property of the document.

Tell the document to use a different header and footer on the first page.

Set the textFont attributes for the rest of the document.

Set textFont folder (will override default textFont folder(s)).

Set textFont folders (will override default textFont folder(s)).

Set keywords property of the document.

Set paper orientation to landscape

Set paper orientation to portrait

Set the paper size of the document.

Set title property of the document.

Set version property of the document.

Use the method to update the TOC (table of contents).