The pdfe object is the root object of the My Scripts Host object model hierarchy. It never needs to be instantiated before invoking its properties and methods, and it is always available from any script. The pdfe object provides access to information such as: the list of selected files passed when the script started, the name of the running script and the list of defined metadata properties. The pdfe object allows you to: access the internal specific PDF processing objects, create objects, connect to objects, sync events, stop a script's execution programmatically and output information to the output window.

This object implements also many of the Windows Script Host WScript root object methods and properties, and to make the My Scripts Host compatible with scripts for the WSH, this pdfe root object also exists under the WScript name, so WSH compatible scripts can run without changes.

The following JScript code echoes the title metadata property of all the selected files used to start the script.

for (i = 0; i < pdfe.SelectedFiles.Count; i++) {
 var Item = pdfe.SelectedFiles(i);
 pdfe.echo(Item.Metadata.Title);
 }

Arguments Property | Clipboard Property | FullName Property | Host Property | Interactive Property | MetadataFieldsInfo Property | OpenDialog Property | ProgressBar Property | SaveDialog Property | ScriptFullName Property | ScriptName Property | SelectedFiles Property | Version Property

Alert Method | BringWindowToFront Method | ConnectObject Method | CreateDocumentMerger Method | CreateFileObject Method | CreateObject Method | DialogBox Method | Echo Method | MessageBox Method | Quit Method | Sleep Method | VarToStr Method

Count Property | Item Property

CommitChanges Method

ArtBox Property | BleedBox Property | CropBox Property | Height Property | MediaBox Property | Rotation Property | Text Property | TextEx Property | TrimBox Property | Width Property

RenderToFile Method | RenderToImage Method

Count Property | Item Property

This object has no methods

Max Property | Min Property | Position Property

This object has no methods

Bottom Property | Left Property | Right Property | Top Property

This object has no methods

Caption Property | PropertyName Property

This object has no methods

Item Property | Length Property

Count Method

Author Property | Calculated Property | Count Property | CreationDate Property | Creator Property | Custom Property | EncryptLevel Property | Item Property | Keywords Property | ModificationDate Property | Producer Property | Subject Property | Title Property | Version Property

CommitChanges Method

var ProgressBar = pdfe.ProgressBar;
ProgressBar.max = pdfe.SelectedFiles.Count;
for (var i = 0; i < pdfe.SelectedFiles.count; i++) {
    ProgressBar.position = i + 1;
    var doc = pdfe.SelectedFiles(i);
    if (doc.AttachmentRoot.Children.Count > 0) {
        pdfe.echo('>' + doc.filename, 0x0000FF);
        DumpAttachments('  ', doc.AttachmentRoot.Children);
    }
}

function DumpAttachments(parentName, Attachments) {
    if (Attachments) {
        for (var i = 0; i < Attachments.count; i++) {
            var attachment = Attachments(i);
            if (attachment.AttType == 1 /*attFile*/ ) {
                var desc = (attachment.description.length > 0) ? ' : ' + attachment.description : "";
                pdfe.echo(parentName + attachment.name + desc);
            } else {
                DumpAttachments(parentName + attachment.name + '\\', attachment.Children);
            }
        }
    }
}

AttType Property | Children Property | Description Property | Name Property

SaveTo Method

Count Property | Item Property

This object has no methods

Count Property | Item Property

This object has no methods

The following JScript dump the bookmark names of the document bookmark tree.

var ProgressBar = pdfe.ProgressBar;
ProgressBar.max = pdfe.SelectedFiles.Count;
for (var i = 0; i < pdfe.SelectedFiles.count; i++) {
    ProgressBar.position = i + 1;
    var doc = pdfe.SelectedFiles(i);
    if (doc.BookmarkRoot && doc.BookmarkRoot.Children) {
        pdfe.echo('>' + doc.filename, 0x0000FF);
        DumpBookmark(doc.BookmarkRoot, 0);
    }
}

function DumpBookmark(bookmark, index) {
    if (bookmark) {
        if (index > 0) pdfe.echo(Array(index * 3).join(" ") + bookmark.name);
        var children = bookmark.Children;
        if (children) {
            for (var i = 0; i < children.count; i++) {
                DumpBookmark(children(i), index + 1);
            }
        }
    }
}

Children Property | DestPageIndex Property | Name Property

This object has no methods

The following JScript code exemplifies how to use the two different merge functions.

var Merger = pdfe.CreateDocumentMerger();
Merger.BookmarkAll1stPages = true;


//merge all selected documents odd pages
for (var i = 0; i < pdfe.SelectedFiles.Count; i++) {
    Merger.MergeDocument(pdfe.SelectedFiles(i).Filename,'odd');
}
Merger.EndAndSaveTo('C:\\Temp\\Merged_OddPages.pdf');

//Merge all document 1st page, passing IPDFPage objects, and at same time rotate the page 
for (var i = 0; i < pdfe.SelectedFiles.Count; i++) {
    var page=pdfe.SelectedFiles(i).Pages(0);
    page.Rotation=90;
    Merger.MergePage(page);
}
Merger.EndAndSaveTo('C:\\Temp\\Merged_1sPages.pdf');

BookmarkAll1stPages Property | GroupBookmarksByDocument Property | GroupLayersByDocument Property | KeepBookmarks Property | KeepLayers Property | LastError Property

EndAndSaveTo Method | MergeBlankPage Method | MergeDocument Method | MergePage Method

Count Property | Item Property

This object has no methods

Author Property | Contents Property | Date Property | Name Property | Rect Property | Type Property

This object has no methods

pdfe.clipboard.AsText="Hello World";
pdfe.echo(pdfe.clipboard.AsText);

AsText Property

This object has no methods