Searching a Book Using ExtendScript

Here is a shell that I use all the time. The idea is that if the document is already open, it is used; otherwise, the script opens it. When you are done processing it, the script will only save and close documents that it opened. This is consistent with FrameMaker's built-in behavior. You never want to save and close an open document unless you are sure you get the desired result.

function processBook (book) {
    
    var bookComp = 0, doc = 0;
    
    // Loop through all of the components in the book.
    bookComp = book.FirstComponentInBook;
    while (bookComp.ObjectValid ()) {
        if (bookComp.ComponentType === 512) {
            // Get the document returned in a JavaScript object.
            doc = getDocument (bookComp.Name, undefined, true);
            if (doc) {
                book.StatusLine = "Processing " + File(bookComp.Name).displayName;
                // Call the function to process the document.
                processDoc (doc);
                // If the document was opened by the script, save it and close it.
                if (doc.openedByScript === true) {
                    doc.SimpleSave (bookComp.Name,false);
                    doc.Close (true);
                }
            }
        }
        bookComp = bookComp.NextBookComponentInDFSOrder;
    }
    // Reset the book status line.
    book.StatusLine = "";
}

function getDocument (filename, structApp, visible) {
    
    // See if the document is already open.
    var doc = docIsOpen (filename);
    if (doc) {
        return doc;
    } else {
        // The document is not already open, so open it.
        return openDocOrBook (filename, structApp, visible);
    }
}

function docIsOpen (filename) {
    
    // Make a File object from the file name.
    var file = File (filename);
    // Uppercase the filename for easy comparison.
    var name = file.fullName.toUpperCase ();

    // Loop through the open documents in the session.
    var doc = app.FirstOpenDoc;
    while (doc.ObjectValid () === 1) {
        // Compare the document’s name with the one we are looking for.
        if (File (doc.Name).fullName.toUpperCase () === name) {
            // The document we are looking for is open.
            doc.openedByScript = false;
            return doc;
        }
        doc = doc.NextOpenDocInSession;
    }
}

function openDocOrBook (filename, structApp, visible) {
    
    var i = 0, docOrBook = 0;

    // Get default property list for opening documents.
    var openProps = GetOpenDefaultParams ();
    // Get a property list to return any error messages.
    var retParm = new PropVals ();

    // Set specific open property values to open the document.
    i = GetPropIndex (openProps, Constants.FS_AlertUserAboutFailure);
    openProps[i].propVal.ival = false;
    i = GetPropIndex (openProps, Constants.FS_MakeVisible);
    openProps[i].propVal.ival = visible;
    i = GetPropIndex (openProps, Constants.FS_FileIsOldVersion);
    openProps[i].propVal.ival = Constants.FV_DoOK;
    i = GetPropIndex (openProps, Constants.FS_FileIsInUse);
    openProps[i].propVal.ival = Constants.FV_ResetLockAndContinue;
    i = GetPropIndex (openProps, Constants.FS_FontChangedMetric);
    openProps[i].propVal.ival = Constants.FV_DoOK;
    i = GetPropIndex (openProps, Constants.FS_FontNotFoundInCatalog);
    openProps[i].propVal.ival = Constants.FV_DoOK;
    i = GetPropIndex (openProps, Constants.FS_FontNotFoundInDoc);
    openProps[i].propVal.ival = Constants.FV_DoOK;
    i = GetPropIndex (openProps, Constants.FS_RefFileNotFound);
    openProps[i].propVal.ival = Constants.FV_AllowAllRefFilesUnFindable;
    if (structApp !== undefined) {
        i = GetPropIndex (openProps, Constants.FS_StructuredOpenApplication);
        openProps[i].propVal.sval = structApp;
    }

    // Attempt to open the document.
    docOrBook = Open (filename, openProps, retParm);

    if (docOrBook.ObjectValid () === 1) {
        // Add a property to the document or book, indicating that the script opened it.
        docOrBook.openedByScript = true;
    }
    else {
        // If the document can't be open, print the errors to the Console.
        PrintOpenStatus (retParm);
    }

    return docOrBook; // Return the document  or book object.
}