My Scripts API
Scripts API

PDFE Objekt

Giver adgang til rodobjekt for Scripts Host objekt model. Som så mange andre steder er kodesprog på engelsk. Skønt oversat til dansk kræver det følgende en grundliggende forståelse af programmeringslogik. Brugere med erfaring med scripts kan måske have mere nytte af den engelsksprogede hjælp i programmets "Help"- mappe.

Bemærkninger

Pdfe objekt er rodobjekt for Scripts Host objektmodel-hierarkiet. Det behøver ikke instantieres før benyttelse af dets egenskaber og metoder, og det er altid tilgængeligt fra ethvert script script. Pdfe objektet giver adgang til information som: En liste over valgte filer ved scriptstart, navnet på scriptet og listen over definerede metadataegenskaber. Objektet tillader: Adgang til de interne PDF-behandlende objekter, opret objekter, forbind til objekter, synkronisere hændelser, stoppe scriptets udførelse og output information til outputvinduet.

Objektet implementerer også mange af Windows Script Host WScript rodobjektets metoder og egenskaber, og for at gøre Scripts Host kompatibel med scripts for WSH, eksisterer dette pdfe rodobjekt også under WScript-navn, så WSH kompatible scripts kan afvikles uden ændringer.

Eksempel

Denne JScript-kode udlæser titel-metadata egenskaben fra de filer, som er valgt ved scriptstart.

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

Egenskaber

Metoder

Egenskabsbeskrivelse

Arguments : IArguments (læs)

(WSH) - Returnerer IArguments objektet (en samling af argumenter).

FullName : String (læs)

(WSH) - Returnerer stien til værtsprogrammet.

Host : Object (read)

Bruges ikke

Interactive : Boolean (læs;skriv)

(WSH) - Sætter eller identificerer scriptets brugerhandlings-tilstand. Når "til" (on – standard), forudsættes en brugerhandling. Hvis "fra" (off), afvikles uden I/O funktionalitet.

MetadataFieldsInfo : IMetadataFieldsInfo (læs)

Returnerer IMetadataFieldsInfo objektet (en samling af IMetadataFieldInfo objekter).

OpenDialog : Object (læs)

Leverer et simpel åbn-fil dialog objekt.

ProgressBar : IProgressBar (læs)

Returnerer IProgressBar objekt (et objekt til at tilgå Scripts Host GUI's fremskridtsmåler).

SaveDialog : Objekt (læs)

Leverer et simpelt gem-fil dialog objekt.

ScriptFullName : String (læs)

(WSH) - Returnerer hele stien til det aktuelle script.

ScriptName : String (læs)

(WSH) - Returnerer navnet på det aktuelle script.

SelectedFiles : ISelectedFiles (læs)

Returnerer ISelectedFiles objekt (en samling af IFileObject).

Version : String (læs)

(WSH) - Returnerer Script Host versionen.

Metodebeskrivelse

Alert( String msg )

Viser en advarselsboks med en meddelelse og en OK-knap.

Parametre

BringWindowToFront( unsigned short hWnd, [Boolean KeepAlwaysOnTop] )

Lægger det angivne vindue øverst.

Parametre

ConnectObject( Objekt objEventSource, String Prefix ) : Objekt

(WSH) - Forbinder objektets hændelseskilde til funktioner med et bestemt præfiks.

Parametre

CreateDocumentMerger( ) : IDocumentMerger

Returnerer et IDocumentMerger objekt, anvendes til at samle flere dokumenter i et nyt.

CreateFileObject( String Filename ) : IFileObject

Danner et fritstående IFileObject.

Parametre

CreateObject( String ProgID, [String Prefix] ) : Objekt

(WSH) - Opretter et COM-objekt.

Parametre

  • ProgID : String

    Stringværdi, der viser ProgID for det objekt, som skal oprettes.

  • Prefix : String (valgfri)

    Stringværdi, der viser funktionens præfiks.

Eksempel

Følgende JScript opretter en forekomst af Internet Explorer og sætter hændelsesfunktionens præfiks to "objIE_". Så foretages en Google-søgning efter den først fundne forfatter i metadata-egenskaberne. Det viser også, hvordan hændelsesfunktions præfiks anvendes til at opfange objektets hændelser.

var objIE = pdfe.CreateObject("InternetExplorer.Application", "objIE_");
objIE.Visible = true;
objIE.Navigate('www.google.com/search?q=' + pdfe.SelectedFiles(0).Metadata.Author.replace(/\s+/g, '+'));
pdfe.BringWindowToFront(objIE.HWND);
boolBrowserRunning = true;
while (boolBrowserRunning && objIE.Visible) {
    pdfe.Sleep(500);
}

function objIE_NavigateComplete2(pDisp, URL) {
    pdfe.Echo("Der er gået til: " + URL);
}

function objIE_OnQuit() {
    boolBrowserRunning = false;
    pdfe.Echo("Lukket");
}

Echo( String msg, [Integer color], [unsigned short option] )

(WSH) - Udlæser teksten.

Parametre

  • msg : String

    String-værdi, som viser teksten, der skal udlæses.

  • color : Heltal (valgfri)

    Heltalsværdi, som viser RGB-farven på den udlæste tekst.

  • option : unsigned short (valgfri)

    Én af følgende værdier:

    none=0 - Normalt echo, uden speciel behandling (standard)
    append=1 - Føjer til forrige echo output linje
    replace=2 - Erstatter forrige echo output linje
    clsscr=3 - Rydder alle foregående output linjer. Meddelelsen ignores

Eksempel

pdfe.echo('Red',0xFF0000);
pdfe.echo('Green',0x00FF00);
pdfe.echo('Blue',0x0000FF);
pdfe.echo('Default text color');
pdfe.echo('Append to the last line',0,1);

MessageBox( String lpText, String lpCaption, unsigned short uType ) : Heltal

Viser en dialogboks med en systemikon, et sæt knapper, og en kort programorienteret meddelelse, så som status eller fejlbeskrivelse. Boksen returnerer en heltalsværdi, som viser hvilken knap, der blev klikket på.

Parametre

  • lpText : String

    Meddelelsen, der skal vises. Hvis der er mere end en linje, kan de adskilles med vognretur og/eller line feed tegn mellem linjerne.

  • lpCaption : String

    Boksens titel

  • uType : unsigned short

    Boksens indhold og virkemåde. Denne parameter kan bestå af en kombination af flag.

Quit( [Heltal ErrorCode] )

(WSH) - Tvinger afviklingen af scriptet til at stoppe.

Parametre

  • ErrorCode : Heltal (valgfri)(bruges ikke)

     

Sleep( Heltal Duration )

(WSH) - Pauser afviklingen af scriptet i et bestemt tidsrum, derefter fortsætter afviklingen.

Parametre

  • Duration : Heltal

    Heltalsværdi, som angiver pausen (i millisekunder).

VarToStr( Variant Value, [String default] ) : String

Ændrer en variabel til en stringtype.

Parametre

ISelectedFiles Objekt

Objekter til en samling af valgte filer, filtret efter filtyper, som scriptet kan virke på og i den rækkefølge, som de oprindeligt blev valgt.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Count : Integer (læs)

Returnerer antallet af ISelectedFile emner i samlingen.

Item( Heltal Indeks ) : IFileObject (læs;standard)

Fremviser et specifikt IFileObject emne fra samlingen.

IFileObject Objekt

Rodobjektet til al dokumentbehandling.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Egenskabsbeskrivelse

Annotations( [Integer Page], [String Types] ) : IAnnotations (læs)

Returnere listen med hele dokumentet eller dokumentside, PDF-kommentarer.

Parameters

  • Page : Integer (valgfri)

    Hvis angivet returneres kun en liste med kommentarer for det angivne sideindeks.

  • Types : String (valgfri)

    - En kommasepareret liste med alle kommentartyper, der skal søges efter. F.eks. Annotations(-1, "Text,FreeText");
    - Listen kan indeholde enhver af disse kommentartyper: Text, FreeText, Line, Square, Circle, Polygon, PolyLine, Highlight, Underline, Squiggly, StrikeOut, Stamp, Caret, Ink, FileAttachment, Sound, Link, Popup, Movie, Widget, Screen, PrinterMark, TrapNet, Watermark, 3D.
    - Returnerer alle fundne kommentarer, hvis de ikke er specificeret eller tom.

 

AttachmentRoot : IAttachment (læs)

Vedhæftningers rod til deres filstruktur. Eksisterer ikke fysisk som en vedhæftning, men oprettes af programmet for at tilgå vedhæftningernes mappestruktur.

BookmarkRoot : IBookmark (læs)

Bogmærkernes rod til deres filstruktur. Dette bogmærke vises ikke for brugeren, men oprettes af programmet for at tilgå filstrukturen og under-bogmærker.

DateLastModified : Dato (læs)

Returnerer seneste ændringsdato.

EmbeddedFiles : IAttachments (læs)

Listen med alle andre indlejrede filer, der ikke er inkluderet i listen over vedhæftninger

FileSize : Heltal (læs)

Returnerer filstørrelse.

Filename : String (læs)

Returnerer filnavn med sti.

Locked : Boolean (læs;skriv)

Bruges ikke.

Metadata : IFileMetadata (læs;standard)

Returnerer dokumentets IFileMetadata objekt.

NumPages : Heltal (læs)

Returnerer sideantallet.

Pages : IPDFPages (læs)

Returnerer dokumentets IPDFPage objekt.

Metodebeskrivelse

Close( )

Lukker PDF filhåndtag ("file handle").

IPDFPages Objekt

Alle sider i dokumentet.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Egenskabsbeskrivelse

Count : Heltal (læs)

Returnerer antallet af IPDFPage emner i samlingen.

Item( Heltal Index ) : IPDFPage (læs;standard)

Viser et specifikt IPDFPage emne fra samlingen.

Metodebeskrivelse

CommitChanges( [String Filename], [Boolean CreateBackup] ) : Boolean

Gemmer forandringer.

Parametre

  • Filename : String (valgfri)

     

  • CreateBackup : Boolean (valgfri)

     

Eksempel

...
Page.CropBox.left=Page.CropBox.left+10;
Page.CropBox.left=Page.CropBox.right-10;
Pages.CommitChanges();

IPDFPage Object

Et sideobjekt i dokumentet.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

ArtBox : IFloatRect (læs;skriv)

Sætter eller returnerer sidens ArtBox rektangel.

BleedBox : IFloatRect (læs;skriv)

Sætter eller returnerer sidens BleedBox rektangel.

CropBox : IFloatRect (læs;skriv)

Sætter eller returnerer sidens CropBox rektangel.

Height : Single (læs)

Finder sidehøjde.

MediaBox : IFloatRect (læs;skriv)

Sætter eller returnerer sidens MediaBox rektangel.

Rotation : Heltal (læs;skriv)

Sætter eller returnerer sidens rotationsvinkel.

Text : String (læs)

Finder sidens tekstindhold.

TextEx : Object (læs)

Finder sidens udvidede tekstindhold.

TrimBox : IFloatRect (læs;skriv)

Sætter eller returnerer sidens TrimBox rektangel.

Width : Single (læs)

Finder sidebredde.

IMetadataFieldsInfo Objekt

Giver adgang til alle metadatafelters definitioner, standard og brugeroprettet.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Count : Heltal (læs)

Returnerer antallet af IFileMetadata emner i samlingen.

Item( Heltal Index ) : IMetadataFieldInfo (læs;standard)

Viser et specifikt IFileMetadata emne fra samlingen.

IProgressBar Objekt

Giver adgang til Scripts Host GUI fremskridtsmåler.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Max : Heltal (læs;skriv)

Sætter eller returnerer maksimumpositionen.

Min : Heltal (læs;skriv)

Sætter eller returnerer minimumpositionen.

Position : Heltal (læs;skriv)

Sætter eller returnerer positionen.

IFloatRect Objekt

Et simpelt rektangelstruktur objekt.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Bottom : Single (læs;skriv)

 

Left : Single (læs;skriv)

 

Right : Single (læs;skriv)

 

Top : Single (læs;skriv)

 

IMetadataFieldInfo Objekt

Et metadatafelt info-objekt, til at få information om definerede karakteristika.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Caption : String (læs)

Returnerer det viste navn for egenskabsfeltet.

PropertyName : String (læs)

Returnerer det interne navn for egenskabsfeltet.

IArguments Objekt

(WSH) - Giver adgang til alle kommandolinje-parametre, i den rækkefølge, som de oprindeligt blev indgivet.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Egenskabsbeskrivelse

Item( Heltal Index ) : String (læs;standard)

(WSH) - Viser et specifikt emne.

Length : Heltal (læs)

(WSH) - Returnerer antallet af kommandolinje-parametre i et script (antallet af emner i et arguments samling).

Metodebeskrivelse

Count( ) : Heltal

(WSH) - Returnerer antallet af emner i et arguments samling.

IFileMetadata Objekt

Læse og skrive dokument metadataegenskaber.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Egenskabsbeskrivelse

Author : String (læs;skriv)

Returnerer eller sætter metadatafeltet Forfatter.

Calculated( Heltal Indeks ) : String (læs) (bruges ikke)

Returnerer et, specificeret med indeks, beregnet metadatafelt.

Count : Heltal (læs)

Returnerer antallet af metadata-emner i samlingen.

CreationDate : Variant (læs;skriv)

Returnerer eller sætter metadatafeltet Oprettet.

Creator : String (læs;skriv)

Returnerer eller sætter metadatafeltet Program.

Custom( Heltal Indeks ) : String (læs;skriv)

Returnerer eller sætter et, specificeret med indeks, brugerdefineret metadatafelt.

EncryptLevel : Heltal (læs)

Returnerer dokumentets krypteringsniveau.

Item( Heltal Index ) : Variant (læs;standard)

Viser et specifikt metadataemne fra samlingen.

Keywords : String (læs;skriv)

Returnerer eller sætter metadatafeltet Nøgleord.

ModificationDate : Variant (læs;skriv)

Returnerer eller sætter metadatafeltet Redigeret.

Producer : String (læs;skriv)

Returnerer eller sætter metadatafeltet Pdf-producent.

Subject : String (læs;skriv)

Returnerer eller sætter metadatafeltet Emne.

Title : String (læs;skriv)

Returnerer eller sætter metadatafeltet Titel.

Version : String (læs)

Returnerer dokumentversion.

Beskrivelse af metoder

CommitChanges( [Boolean DBOnly] ) : Boolean

Gemmer metadataændringer.

Parametre

  • DBOnly : Boolean (valgfri) (bruges ikke)

     

IAttachment Objekt

Repræsenterer et vedhæftet objekt. Rodvedhæftningen fås fra IFileObject AttachmentRoot egenskaben.

Bemærkninger

 

Eksempel

Følgende JScript laver et dump navne og beskrivelser for alle vedhæftninger i dokumentet.

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);
            }
        }
    }
}

Egenskaber

Metoder

Egenskabsbeskrivelse

AttType : brugerdefineret type (læs)

Type (attFolder=0,attFile=1) af vedhæftning.

Children : IAttachments (læs)

Et IAttachments objekt, som lister undermapper, hvis typen er attFolder.

Description : String (læs)

Teksten med den vedhæftningsbeskrivelse, som ses i vedhæftningspanelet.

Name : String (læs)

Teksten med det vedhæftningsnavn, som ses i vedhæftningspanelet.

Metodebeskrivelse

SaveTo( String Path ) : Boolean

Gemmer vedhæftningen til en ekstern fil eller mappe.

Parametre

  • Path: String

    Hvis typen er attFolder, den komplette sti til mappen, hvor alle vedhæftninger skal gemmes.
    Hvis typen er attFile, kan den være blot en komplet mappesti og filnavnene bliver vedhæftningernes. Eller en komplet mappe- og filsti for også at bestemme det filnavn, som skal bruges.

IAttachments Objekt

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Count : Heltal (læs)

 

Item( Heltal Indeks ) : IAttachment (læs:standard)

 

IBookmarks Objekt

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Count : Heltal (læs)

 

Item( Heltal Indeks ) : IBookmark (læs:standard)

 

IBookmark Objekt

Repræsenterer et bogmærke nodeobjekt. Bogmærkeroden, ikke synlig for brugeren, fås fra IFileObject BookmarkRoot egenskaben.

Bemærkninger

 

Eksempel

Følgende JScript laver et dump af bogmærkenavnene i dokumentets bogmærkestruktur.

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);
            }
        }
    }
}

Egenskaber

Metoder

Objektet har ingen metoder.

Egenskabsbeskrivelse

Children : IBookmarks (læs)

Et IBookmarks objekt, som lister underbogmærkerne fra bogmærket i bogmærkestrukturen.

DestPageIndex : Integer (læs)

Den søgte side, 0-baseret, indeksering. Returnerer -1, hvis målet ikke er en side i dokumentet eller ikke kan bestemmes.

Name : String (læs)

Teksten for bogmærket, som brugeren ser det i navigationsruden.

IDocumentMerger Objekt

Et dokumentsamlingsobjekt.

Bemærkninger

 

Eksempel

Dette JScript code viser, hvorledes de to samlefunktioner kan anvendes:

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


//Samle alle de valgte dokumenters ulige sider
for (var i = 0; i < pdfe.SelectedFiles.Count; i++) {
    Merger.MergeDocument(pdfe.SelectedFiles(i).Filename,'odd');
}
Merger.EndAndSaveTo('c:\\Temp\\Samlet_UligeSider.pdf');

//Samle alle 1. sider, forbigå IPDFPage objekter, og rotér samtidigt siden. 
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\\Samlede_1_sider.pdf');

Egenskaber

Metoder

Egenskabsbeskrivelse

BookmarkAll1stPages : Boolean (læs;skriv)

Sætter eller finder et bogmærke på dokumentets første side. Skal altid tages med – også for dokumenter uden bogmærker.

GroupBookmarksByDocument : Boolean (læs;skriv)

Hvis bogmærker er bibeholdt, sætter eller finder om bogmærker er grupperet i et samlet dokument.

GroupLayersByDocument : Boolean (læs;skriv)

Hvis lag er bibeholdt, sætter eller finder om lag er grupperet i et samlet dokument.

KeepBookmarks : Boolean (læs;skriv)

 Sætter eller finder om bogmærker er bibeholdt.

KeepLayers : Boolean (læs;skriv)

Sætter eller finder om lag er bibeholdt.

LastError : String (læs)

Hvis en samlefunktion returnerer fejl, holder denne egenskab fejlmeddelelsen.

Beskrivelse af metoder

EndAndSaveTo( String Filename ) : Boolean

Afslutter samleoperationen og gemmer resultatet som et dokument med fastsat navn. Efter udførelsen kan objektet starte næste samleoperation.

Parametre

MergeBlankPage( [Heltal Width], [Heltal Height] ) : Boolean

Samler med tom side med bredde og højde i millimeter.

Parametre

MergeDocument( String Filename, [String PagesRange] ) : Boolean

Samler et dokument med specificeret filnavn og – eventuelt – sider, der skal medtages.

Parametre

MergePage( IPDFPage Page ) : Boolean

Samler en side, specificerende dens IPDFPage objekt.

Parametre

IAnnotations Object

Benærkninger

 

Eksempel

 

Egenskaber

Metoder

Dette objekt har ingen metoder

Egenskabsbeskrivelse

Count : Integer (læs)

 

Item( Integer Index ) : IAnnotation (læs)

 

IAnnotation Object

Repræsentere en PDF kommentar. Dokument/side kommentarer fås fra IFileObject Annotations egenskaben.

Bemærkninger

 

Eksempel

 

Egenskaber

Metoder

Dette objekt har ingen metoder

Egenskabsbeskrivelse

Author : String (læs)

 

Contents : String (læs)

 

Date : String (læs)

 

Name : String (læs)

 

Rect : IFloatRect (læs)

 

Type : String (læs)

Enhver af de mulige kommentartyper: Text, FreeText, Line, Square, Circle, Polygon, PolyLine, Highlight, Underline, Squiggly, StrikeOut, Stamp, Caret, Ink, FileAttachment, Sound, Link, Popup, Movie, Widget, Screen, PrinterMark, TrapNet, Watermark, 3D.

(c) 2006-2017 RTT