OBS/Makros und Scripting/Allgemeines/Klassen/PDF Verarbeitung/TOBS PDF

Wiki » Makros und Scripting

Makros und Scripting

Allgemeines

• Syntax
• Übersicht Funktionen
• Übersicht Prozeduren
• Übersicht Konstanten
• Übersicht Globale Variablen

Klassen

Vorgangsgenerierung

• Angebot
• Auftrag
• Reparaturauftrag
• Produktionsauftrag
• Lieferschein
• Rechnung
• Bestellung
• Einkaufslieferschein
• Einkauf

Import-Dateien

• TxImportFile
• TxImportFileCSV

PDF-Verarbeitung

• TOBS_PDF

• Script Bibliothek

Anwendungsbereiche

• Drucke
• Interaktive PDF
• Sonstige Makrodateien

Customizing

• Übersicht
• Rechte Verwaltung
• Listen
• Edits
• Select-Listen
• Übrige Fenster (xForm)

• Preislisten
• Bildverwaltung
• Artikelpflege
• Office Unterstützung
• Positionserfassung
• Data In/Out
• Wiederkehrende Aufgaben
• OFML-Kalkulation
• Zugriff auf externe Datenquellen (ODBC)
• Allgemeine Konvertierungen
• Vorgangsbaum
• Benutzerfelder
• Listen Stable
• ZUGFERD
• OpenTRANS

Beispiele

• Beispiele Sammlung

Benutzerdefinierte Datenbanktabellen

Developer

• User-Datenbank
• User-Listen
• User-Edits
• User-Widgets

Beispiele

• Positionen
• Vorgangs-Mail Betreff

Sonstiges

• DMS Abkürzungen

Struktur

Variablen

oPDFDoc

Definition:

oPDFDoc : TgtPDFDocument;

Erklärung:
das geladene Dokument.

Methoden

Create

Definition:

constructor Create(oxDB:TxDB);

Erklärung:
Erstellt eine Instanz für das Objekt TOBS_PDF.

Beispiel:

oPDF := oPDF := TOBS_PDF.Create(oDB);

Destroy

Definition:

destructor  Destroy();

Erklärung:
gibt die Instanz und alle Internen Objekte für das Objekt TOBS_PDF im Speicher wieder frei.

Beispiel:

oPDF.Free;

LoadFromFile

Definition:

function  LoadFromFile(const cFileName: string; cPassword:String=''):Boolean;

Erklärung:
Lädt die angegeben PDF-Datei ein

Beispiel:

oPDF.LoadFromFile('c:\MusterEinfach.pdf');

SaveToFile

Definition:

procedure SaveToFile(const cFileName:string; lIncremental:Boolean=False; lAutoReload:Boolean=False);

Erklärung:
Speichert die geladene PDF-Datei unter einen neuen Namen ab.
lIncremental: Speichert nur die Teile des Dokuments, die geändert wurden.
lAutoReload: Lädt das gespeicherte Dokument ein.

Beispiel:

oPDF.SaveToFile('c:\MusterEinfach_Neu.pdf');

IsLoaded

Definition:

function  IsLoaded():Boolean;

Erklärung:
prüft ob eine Datei geladen wurde.

Beispiel:

if oPDF.IsLoaded() then begin
end;

PageCount

Definition:

function  PageCount():Integer;

Erklärung:
gibt die Anzahl der Seiten zurück.

Beispiel:

nSeiten := oPDF.PageCount();

PageSizeHeight

Definition:

function  PageSizeHeight(nPageNo:Integer; Const cEnum:String):Double;

Erklärung:
gibt die Höhe der angegebenen Seiten zurück.
cEnum: Einheit der Rückgabe
Mögliche Werte: muPixels, muPoints, muInches, muMM, muTwips

Beispiel:

nHeight := oPDF.PageSizeHeight(1, 'muMM');

PageSizeWidth

Definition:

function  PageSizeWidth(nPageNo:Integer; Const cEnum:String):Double;

Erklärung:
gibt die Breite der angegebenen Seiten zurück.
cEnum: Einheit der Rückgabe
Mögliche Werte: muPixels, muPoints, muInches, muMM, muTwips

Beispiel:

nWidth := oPDF.PageSizeWidth(1, 'muMM');

SetMeasurementUnit

Definition:

procedure SetMeasurementUnit(cUnit:String);

Erklärung:
Setzt die Maßeinheit für die Verarbeitung.
Mögliche Einheiten: muPixels, muPoints, muInches, muMM, muTwips

Beispiel:

oPDF.SetMeasurementUnit('muInches');

GetMeasurementUnit

Definition:

function  GetMeasurementUnit():String;

Erklärung:
Gibt die aktuelle Maßeinheit zurück.
Mögliche Einheiten: muPixels, muPoints, muInches, muMM, muTwips

Beispiel:

cUnit := oPDF.GetMeasurementUnit();

InsertBlankPageAt

Definition:

procedure InsertBlankPageAt(nPageNumber:Integer; nPageWidth:Double; nPageHeight:Double);

Erklärung:
Fügt eine leere Seite mit definierter Höhe und Breite an der angegeben Seite ein

Beispiel:

oPDF.InsertBlankPageAt(2, oPDF.PageSizeWidth(1, oPDF.GetMeasurementUnit()), oPDF.PageSizeWidth(1, oPDF.PageSizeHeight()));

ExtractText

Definition:

function  ExtractText(const cPageRange:String; lPageBreak:Boolean):TStringList;

Erklärung:
liest den Text der angegeben Seiten aus.

Beispiel:

oStringList := oPDF.ExtractText('1-2', True);

ExtractTextFormatted

Definition:

function  ExtractTextFormatted(nPageNo:Integer):TStringList;

Erklärung:
liest den Formatierten Text der angegeben Seite aus.

Beispiel:

oStringList := oPDF.ExtractTextFormatted(1);

AddPDFFiles

Definition:

procedure AddPDFFiles(const oList:TStringList);

Erklärung:
Fügt in oList definierte PDF Dateien (Pfad + Dateiname) hinzu.

Beispiel:

oList.Add('c:\MusterEinfach_Merge.pdf')
oPDF.AddPDFFiles(oList);

TextOut

Definition:

procedure TextOut(const cHtmlText:String; x:integer; y:Integer);

Erklärung:
Schreibt HTML Formatierten Text an die definierte Stelle.

Beispiel:

oPDF.TextOut('<B>TEST</B>', 50, 50);

GetPlatzhalter

Definition:

function  GetPlatzhalter() : TStringList;

Erklärung:
gibt alle enthaltenen Platzhalter zurück.
Rückgabe Format: Name + ';' + Typ + ';' + Content
Typen: ftText, ftCheckBox, ftRadio, ftButton, ftSignature, ftChoice, ftListBox, ftComboBox

Beispiel:

oString := oPDF.GetPlatzhalter();

SetPlatzhalter

Definition:

procedure SetPlatzhalter(cPlatzhalter: array of String; cText: array of String);

Erklärung:
Setzt cPlatzhalter mit definierten cText
Datei muss danach gespeichert werden

Beispiel:

oPDF.SetPlatzhalter([Token(oString.Strings[0], ';', 1)], [Token(oString.Strings[0], ';', 3) + 'TEST']);

GetAnmerkung

Definition:

function  GetAnmerkung(nPage: Integer) : TStringList;

Erklärung:
gibt alle enthaltenen Kommentare/Anmerkungen der angebenen Seite zurück.
Rückgabe Format: Name + ';' + Content

Beispiel:

oString := oPDF.GetAnmerkung(1);

SetAnmerkung

Definition:

procedure SetAnmerkung(nPage: Integer; cPlatzhalter: array of String; cText: array of String);

Erklärung:
Setzt cPlatzhalter mit definierten cText auf der anegebenen Seite
Datei muss danach gespeichert werden

Beispiel:

oPDF.SetAnmerkung([Token(oString.Strings[0], ';', 1)], [Token(oString.Strings[0], ';', 2) + 'TEST']);

SetEncryption

Definition:

procedure SetEncryption(const cOwnerPass:String; const cUserPass:String; const cEncryptionLevel:String; const cPermissions:String);

Erklärung:
Setzt die Berechtigungen
cEncryptionLevel: el40bit, el128bit
cPermissions: AllowCopy, AllowModify, AllowPrint, AllowAnnotation, AllowFormFill, AllowAccessibility, AllowDocAssembly, AllowHighResPrint

Beispiel:

oPDF.SetEncryption('123', '123', 'el128bit', 'AllowCopy, AllowModify');

ShowPDF

Definition:

procedure ShowPDF(const cFileName:String);

Erklärung:
öffnet die PDF Datei

Beispiel:

ShowPDF('c:\MusterEinfach_neu.pdf');

WaterMarkText

Definition:

procedure WaterMarkText(const cText:String; const cPageRange:String; oFont:TFont);

Erklärung:
Schreibt ein Wasserzeichen als Text auf die angegebenen Seiten

Beispiel:

oFont       := TFont.Create();        
oFont.Name  := 'Times New Roman';
oFont.Size  := 40;

oPDF.WaterMarkText('OBS DEMO','1-9',oFont);

WaterMarkBitmap

Definition:

procedure WaterMarkBitmap(oBitMap:TBitmap; const cPageRange:String; oFont:TFont);

Erklärung:
Schreibt ein Wasserzeichen als Bild auf die angegebenen Seiten

Beispiel:

oBitMap := TBitmap.Create();
oBitmap.LoadFromFile('c:\Temp.bmp');

oFont       := TFont.Create();        
oFont.Name  := 'Times New Roman';
oFont.Size  := 40;

oPDF.WaterMarkText(oBitMap ,'1-9',oFont);

GetPDFInfo

Definition:

procedure GetPDFInfo(var cTitel        : String;
                     var cAuthor       : String;
                     var cSubject      : String;
                     var cKeywords     : String;
                     var cCreator      : String;
                     var cProducer     : String;
                     var cCreationDate : String;
                     var cModDate      : String);

Erklärung:
Gibt Informationen über das PDF zurück
Die übergebenen Variablen beinhalten dabei die Informationen

Beispiel:

procedure GetPDFInfo(cTitel,
                     cAuthor,
                     cSubject,
                     cKeywords,
                     cCreator,
                     cProducer,
                     cCreationDate,
                     cModDate);

SetPDFInfo

Definition:

procedure SetPDFInfo(Const cTitel        : String;
                     Const cAuthor       : String;
                     Const cSubject      : String;
                     Const cKeywords     : String;
                     Const cCreator      : String;
                     Const cCreationDate : String;
                     Const cModDate      : String);

Erklärung:
Setzt Informationen über das PDF neu

Beispiel:

procedure SetPDFInfo(cTitel,
                     cAuthor,
                     cSubject,
                     cKeywords,
                     cCreator,
                     cProducer,
                     cCreationDate,
                     cModDate);