L'API Script personali
L'API Script personali

L'Oggetto PDFE

Fornisce l'accesso all'oggetto radice per il modello ad oggetti Host Script personali.

Annotazioni

L'oggetto pdfe Ŕ l'oggetto radice della gerarchia del modello ad oggetti Host Script personali. Non deve essere istanziato per invocarne metodi e proprietÓ ed Ŕ sempre disponibile, in qualunque script. L'oggetto pdfe fornisce accesso ad informazioni come l'elenco di file passati all'avvio dello script, il nome dello script in esecuzione e l'elenco delle proprietÓ dei metadati definiti.
L'oggetto pdfe permetti di: accedere a specifici oggetti interni per l'elaborazione del PDF, creare oggetti, stabilire connessioni agli oggetti, sincronizzare eventi, arrestare l'esecuzione di uno script a livello di programmazione e restituire l'output direttamente su una finestra di output.

Questo oggetto implementa numerosi metodi e proprietÓ dell'oggetto radice WScript di Windows Script Host, e per rendere l'Host Script personali compatibile con WSH, questo oggetto radice pdfe esiste anche con il nome WScript determinando, in questo modo, la compatibilitÓ degli WSH senza necessitÓ di apporre cambiamenti.

Esempio

Il codice JScript seguente restituisce la proprietÓ titolo dei metadati per tutti i file selezionati usati per avviare lo script.

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

ProprietÓ

Metodi

Decrizione delle proprietÓ

Arguments : IArguments (read)

(WSH) - Restituisce l'oggetto IArguments (una raccolta di argomenti).

FullName : String (read)

(WSH) - Restituisce il percorso completo per l'eseguibile dell'host.

Interactive : Boolean (read;write)

(WSH) - Imposta o identifica la modalitÓ di interazione utente dello script. Se abilitata (opzione predefinita) abilita l'interazione da parte dell'utente. Se disabilitata, viene eseguita senza funzionalitÓ per l'input/output utente.

MetadataFieldsInfo : IMetadataFieldsInfo (read)

Restituisce l'oggetto IMetadataFieldsInfo (una raccolta di oggetti IMetadataFieldInfo).

OpenDialog : Object (read)

Fornisce l'oggetto per una finestra base di apertura file.

ProgressBar : IProgressBar (read)

Restituisce l'oggetto IProgressBar (un oggetto per interfacciarsi alla barra progressi principale della GUI Host Script personali).

SaveDialog : Object (read)

Fornisce l'oggetto per una finestra base di salvataggio file.

ScriptFullName : String (read)

(WSH) - Restituisce il percorso completo dello script in esecuzione.

ScriptName : String (read)

(WSH) - Restituisce il nome dello script in esecuzione.

SelectedFiles : ISelectedFiles (read)

Restituisce l'oggetto ISelectedFiles (una raccolta di oggetti IFileObject).

Version : String (read)

(WSH) - Restituisce la versione dell'Host Script personali.

Descrizione dei metodi

Alert( String msg )

Mostra una finestra di avvertimento con il messaggio di testo specificato ed il pulsante OK.

Parametri

BringWindowToFront( unsigned short hWnd )

Porta la finestra specificata in primo piano sull'asse Z.

Parametri

ConnectObject( Object objEventSource, String Prefix ) : Object

(WSH) - Collega le origini degli eventi relativi all'oggetto alle funzioni con un prefisso dato.

Parametri

CreateDocumentMerger( ) : IDocumentMerger

Restituisce l'oggetto IDocumentMerger, usato per unire vari documenti in un unico documento.

CreateFileObject( String Filename ) : IFileObject

Crea un oggetto IFileObject indipendente

Parametri

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

(WSH) - Crea un oggetto COM e associa un prefisso testo alle funzioni event degli oggetto. I.E., se l'oggetto ha un evento denominato OnClick, e viene passato "IEEvents_" come prefisso, Ŕ possibile dichiarare una funzione nello script denominata IEEvents_OnClick, funzione invocata quando l'oggetto attiva l'evento.

Parametri

  • ProgID : String

    Il valore della stringa indicante l'identificativo di programmazione (ProgID) dell'oggetto che si vuole creare.

  • Prefix : String (opzionale)

    Il valore della stringa indicante il prefisso della funzione.

Esempio

Il codice JScript seguente crea un'oggetto dell'istanza Internet Explorer e collega le funzioni degli eventi al prefisso "objIE_". Successivamente utilizza el oggeto per effettuare una ricerca su Google con la proprietÓ autore, dei metadati del primo file selezionato. In aggiuta, mostra come catturare eventi da un oggetto usando el prefisso.

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("You just navigated to :" + URL);
}

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

Echo( String msg, [Integer color] )

(WSH) - Restituisce (stampa) il testo su una finestra di output.

Parametri

  • msg : String

    Il valore della stringa indicante il testo da restituire.

  • color : Integer (optional)

    Valore intero indicante il colore RBG da applicare al testo restituito...

Esempi

pdfe.echo('Rosso',0xFF0000);
pdfe.echo('Verde',0x00FF00);
pdfe.echo('Blu',0x0000FF);
pdfe.echo('Colore di testo predefinito');

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

Mostra una finestra di dialogo caratterizzata da un'icona di sistema, un set di pulsanti, un breve messaggio relativo all'applicazione, come ad esempio lo stato o eventuali errori. Questa finestra restituisce un valore intero indicante quale pulsante sia stato premuto dall'utente.

Parametri

  • lpText : String

    Il messaggio da visualizzare. Se la stringa Ŕ composta da piu' di un rigo, Ŕ possibile separarle con un a capo o un trattino fra ciascuna riga.

  • lpCaption : String

    Il titolo della finestra di dialogo.

  • uType : unsigned short

    Il contenuto ed il comportamento della finestra di dialogo. Questo parametro pu˛ essere una combinazione di flag.

Quit( [Integer ErrorCode] )

(WSH) - Forza l'arresto dello script, in qualunque momento o stato.

Parametri

  • ErrorCode : Integer (opzionale)(non utilizzato)

     

Sleep( Integer Duration )

(WSH) - Sospende l'esecuzione dello script per il periodo di tempo indicato, quindi ne riprende l'esecuzione.

Parametri

  • Duration : Integer

    Il valore, intero, definisce in millisecondi il tempo che di vuole sospendere l'esecuzione dello script.

ISelectedFiles Object

La raccolta dei file oggetto selezionati, filtrati per tipo, a seconda dello script che possa gestirli, ed ordinati per ordine di inserimento.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Count : Integer (read)

Restituisce il numero di elementi ISelectedFile nella raccolta

Item( Integer Index ) : IFileObject (read;default)

Porta il focus su uno specifico elemento IFileObject presente nella raccolta.

Oggetto IFileObject

E' l'oggetto radice per accedere a tutte le funzionalitÓ di elaborazione del documento.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

DateLastModified : Date (read)

Restituisce la data di ultima modifica del file

FileSize : Integer (read)

Restituisce la dimensione del file

Filename : String (read)

Restituisce il percorso completo del file

Metadata : IFileMetadata (read;default)

Restituisce l'oggetto IFileMetadata

NumPages : Integer (read)

Restituisce il numero di pagine del documento

Pages : IPDFPages (read)

Restituisce l'oggetto IPDFPage del documento

Oggetto IPDFPages

La raccolta completa delle pagine del documento

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Count : Integer (read)

Restituisce il numero di elementi IPDFPage nella raccolta

Item( Integer Index ) : IPDFPage (read;default)

Porta il focus su uno specifico elemento IPDFPage presente nella raccolta.

Oggetto IPDFPage

Identifica un oggetto pagina nel documento.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

ArtBox : IFloatRect (read;write)

Imposta o restituisce il rettangolo di pagina ArtBox

BleedBox : IFloatRect (read;write)

Imposta o restituisce il rettangolo di pagina BleedBox

CropBox : IFloatRect (read;write)

Imposta o restituisce il rettangolo di pagina CropBox

Height : Single (read)

Restituisce l'altezza della pagina

MediaBox : IFloatRect (read;write)

Imposta o restituisce il rettangolo di pagina MediaBox

Rotation : Integer (read;write)

Imposta o restituisce l'angolo di rotazione della pagina

Text : String (read)

Ottiene il testo contenuto nella pagina.

TextEx : Object (read)

Ottiene l'oggetto di testo esteso della pagina.

TrimBox : IFloatRect (read;write)

Imposta o restituisce il rettangolo di pagina TrimBox

Width : Single (read)

Restituisce la larghezza della pagina

Oggetto IMetadataFieldsInfo

Fornisce l'accesso all'intera raccolta di definizioni dei campi metadati, predefiniti e personalizzati.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Count : Integer (read)

Restituisce il numero di elementi IFileMetadata nella raccolta.

Item( Integer Index ) : IMetadataFieldInfo (read;default)

Porta il focus su uno specifico elemento IFileMetadata presente nella raccolta.

Oggetto IProgressBar

Fornisce l'accesso alla barra progressi principale della GUI Host Script personali.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Max : Integer (read;write)

Imposta o restituisce la posizione massima della barra progressi.

Min : Integer (read;write)

Imposta o restituisce la posizione minima della barra progressi.

Position : Integer (read;write)

Imposta o restituisce la posizione della barra progressi.

Oggetto IFloatRect

Un semplice rettangolo della struttura oggetto

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Bottom : Single (read;write)

 

Left : Single (read;write)

 

Right : Single (read;write)

 

Top : Single (read;write)

 

Oggetto IMetadataFieldInfo

Un campo metadati informativo per ottenere informazioni sulle proprie caratteristiche di definizione.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Questo oggetto non ha metodi

Descrizione delle proprietÓ

Caption : String (read)

Restituisce il nome visibile del campo proprietÓ.

PropertyName : String (read)

Restituiosce il nome interno del campo proprietÓ.

Oggetto IArguments

(WSH) - Fornisce l'accesso all'intera raccolta di parametri da linea di comando, nell'ordine in cui sono stati originariamente inseriti.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Descrizione delle proprietÓ

Item( Integer Index ) : String (read;default)

(WSH) - Porta in focus su uno specifico elemento della raccolta.

Length : Integer (read)

(WSH) - Restituisce il numero di parametri passati allo script (il numero di elementi in una raccolta di argomenti).

Descrizione dei metodi

Count( ) : Integer

(WSH) - Restituisce il numero di membri nella raccolta.

Oggetto IFileMetadata

Per leggere o scrivere proprietÓ nei metadati del documento.

Annotazioni

 

Esempio

 

ProprietÓ

Metodi

Descrizione delle proprietÓ

Author : String (read;write)

Restituisce o imposta il campo autore nei metadati del documento.

Calculated( Integer Index ) : String (read) (not used)

Restituisce un campo calcolato dei metadati, indicato dall'indice.

Count : Integer (read)

Restituisce il numero di elementi dei metadati nella raccolta.

CreationDate : Variant (read;write)

Restituisce o imposta il campo data di creazione per le proprietÓ dei metadati del documento.

Creator : String (read;write)

Restituisce o imposta il campo autore per le proprietÓ dei metadati del documento.

Custom( Integer Index ) : String (read;write)

Restituisce o imposta un campo personalizzato fra i metadati del documento, indicato dall'indice.

EncryptLevel : Integer (read)

Restituisce il livello di protezione del documento.

Item( Integer Index ) : Variant (read;default)

Sposta il focus su un elemento specifico dei metadati presenti nella raccolta.

Keywords : String (read;write)

Restituisce o imposta il campo parole chiave nei metadati del documento.

ModificationDate : Variant (read;write)

Restituisce o imposta il campo data di ultima modifica nei metadati del documento.

Producer : String (read;write)

Restituisce o imposta il campo prodotto da nei metadati del documento.

Subject : String (read;write)

Restituisce o imposta il campo soggetto/oggetto nei metadati del documento.

Title : String (read;write)

Restituisce o imposta il campo titolo per i metadati del documento.

Version : String (read)

Restituisce la versione del documento.

Descrizione dei metodi

CommitChanges( [Boolean DBOnly] ) : Boolean

Salve le modifiche dei metadati su file.

Parametri

  • DBOnly : Boolean (optional) (not used)

     

IDocumentMerger Object

Un oggetto per l'unione di documenti

Annotazioni

 

Esempio

Il seguente codice JScript chiarisce il funzionamento delle due funzioni di unione fornite.

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


//Unisce le pagine dispari dei documenti selezionati
for (var i = 0; i < pdfe.SelectedFiles.Count; i++) {
    Merger.MergeDocument(pdfe.SelectedFiles(i).Filename,'odd');
}
Merger.EndAndSaveTo('C:\\Temp\\Merged_OddPages.pdf');

//Unisce tutte le prime pagine di ciascun documento utilizzando gli oggetti IPDFPage. 
for (var i = 0; i < pdfe.SelectedFiles.Count; i++) {
    Merger.MergePage(pdfe.SelectedFiles(i).Pages(0));
}
Merger.EndAndSaveTo('C:\\Temp\\Merged_1sPages.pdf');

ProprietÓ

Metodi

Descrizione delle proprietÓ

BookmarkAll1stPages : Boolean (read;write)

Imposta o definisce se debba essere inserito un segnalibro per la prima pagina del documento, anche se i documenti sono privi di segnalibri.

GroupBookmarksByDocument : Boolean (read;write)

Se i segnalibri sono preservati, definisce se devono essere raggruppati per documento unito.

GroupLayersByDocument : Boolean (read;write)

Se i livelli sono preservati, definisce se devono essere raggruppati per documento unito.

KeepBookmarks : Boolean (read;write)

Imposta o definisce se i segnalibri devono essere preservati.

KeepLayers : Boolean (read;write)

Imposta o definisce se i livelli devono essere preservati

LastError : String (read)

Se una o piu' funzioni di unione restituisce un codice di errore, questa proprietà contiene il relativo messaggio di errore.

Descrizione dei metodi

EndAndSaveTo( String Filename ) : Boolean

Finalizza l'operazione di unione e salva il risultato del documento sul file specificato. Quando fatto, l'oggetto Ŕ pronto per una nuova operazione di unione.

Parametri

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

Unisce un documento, specificando il nome del file e, opzionalmente, le pagine da includere.

Parametri

MergePage( IPDFPage Page ) : Boolean

Unisce la pagina di un documento specificando il suo oggetto IPDFPage.

Parametri

(c) 2006-2013 RTT