HostDocument Class

Overview

A HostDocument object represents an application document object inside the host application. Information such as the document's caption or document location can be retrieved.

Methods

HostDocument.getCaption

Returns the document's current caption

HostDocument.getLocation

Returns the document's location

HostDocument.getType

Returns the document's location

HostDocument.setCaption

Changes the document's caption

Example

// A HostDocument is one open document window in the host application.
// Scripts do not construct them; they come from HostApp:
//
//   HostApp.getDocuments()       every open document, as an array
//   HostApp.getActiveDocument()  the one in front, or null
//   HostApp.getDocumentById(id)
//   HostApp.newDocument(), HostApp.open()

const documents = HostApp.getDocuments();

let output = `${documents.length} open document(s)\n\n`;

for (const doc of documents) {
    // getType() gives "table", "query", "report", "editor" or "web", and
    // null for a kind it does not recognise.  getLocation() is null for
    // a document that was never saved -- a new, untitled query, say.
    const type = doc.getType();
    const location = doc.getLocation();

    output += `${doc.getCaption()}\n`;
    output += `    type:     ${type === null ? "unknown" : type}\n`;
    output += `    location: ${location === null ? "(none)" : location}\n`;
}

const active = HostApp.getActiveDocument();

if (active !== null) {
    // setCaption() changes the tab text only; it does not rename or move
    // whatever the document was loaded from
    active.setCaption(`* ${active.getCaption()}`);

    output += `\nmarked the active document: ${active.getCaption()}`;
}

alert(output);