Aloaha PDF Formular API

Die Aloaha PDF Formular API kann dazu verwendet werden, programmiertechnisch auf PDF-Formularfelder zuzugreifen. Auf dieser Seite finden Sie eine Übersicht aller möglichen Funktionen. Beachten Sie jedoch, dass Aloaha PDF Saver Professional dafür notwendig ist. Die Funktionen können nicht mit der Standardversion des Aloaha PDF Form Savers verwendet werden.

Um auf die Funktionen zugreifen zu können, erzeugen Sie das Objekt.

Dim PDF
set PDF = createobject("aloahapdf.edit")

Als nächstes müssen Sie das zu editierende PDF Formular laden. Der Parameter kann eine lokale oder auch eine auf einem Webserver gehostete Datei sein.Zum Beispiel:
http://www.aloaha.com/cache/fs5.pdf

If PDF.load_pdf_to_mem(cstr(c:\form.pdf)) =true then
          msgbox "Form loaded to memory"
          if PDF.FormFields>0 then
                            msgbox "PDF is Form"
          else
                            msgbox "PDF is not a Form"
                            call PDF.unload_pdf_from_mem
          end if
else
         msgbox "Could not load Form to memory"
end if


Um in der Lage zu sein, Formularfelder auszulesen oder zu beschreiben, müssen Sie das entsprechende Formularfeld auswählen.

Formularfelder können über eine ID Nummer oder den Formulartitel ausgewählt werden. Die Auswahl über die ID Nummer ist die schnellere Methode. IDs starten immer bei 1.

if PDF.SelectFormField(clng(1))=true then
         msgbox "First FormField selected"
else
         msgbox "Could not select FormField"
end if

Sollten Ihnen die ID Nummern des Formulars nicht bekannt sein, ist es einfacher, die Formularfelder per Titel auszuwählen.

dim FormFieldID
FormFieldID=PDF.SelectFormFieldbyTitle(cstr("FirstName"))
if FormFieldID>0 then
          if PDF.SelectFormField(clng(FormFieldID))=true then
                    msgbox "FormField "&cstr("FirstName")&" with ID Number "&cstr(FormFieldID)&" selected"
         else
                    msgbox "Could not find FormField"
         end if
else          msgbox "Could not find FormField"
end if

Manchmal können Formularfelder Unterobjekte enthalten. Um ein Unterobjekt zu finden, starten Sie folgenden Aufruf:

If PDF.FormFieldSubs>0 then
        msgbox "Form Field contains Subjobjects"
end if


Falls ein Formularfeld Unterobjekte enthält, können Sie SelectFormFieldSub aufrufen um eines der Unterobjekte auszuwählen.

if PDF.SelectFormFieldSub(2)=true then
         msgbox "Subobject 2 selected"
else
         msgbox "Could not select Subobject"
end if

Nun können Sie den Wert des Formularfeldes setzen oder auslesen.

Das Auslesen des Formularfeld-Wertes sieht folgendermaßen aus:

msgbox PDF.GetPossibleFieldValue

Wie man den Wert des Formularfeldes setzen kann, sehen Sie in folgendem Code:

if PDF.SetFormFieldValue(cstr("This is the new value"))=true then
          msgbox "Value set"
else
         msgbox "Could not set Value"
end if 

Nachdem Sie alle notwendigen Werte gesetzt haben, müssen Sie das PDF-Dokument aus dem Arbeitsspeicher auf einen Datenträger speichern.

Verwenden Sie dazu den Befehl save_pdf_to_file:

if PDF.save_pdf_to_file(cstr("c:\targetpdf.pdf"))=true then
         msgbox "PDF Saved to Disk"
else
         msgbox "Could not Save PDF to Disk"
end if

Jetzt können Sie das PDF-Objekt aus dem Speicher entfernen, wenn Sie es nicht mehr benötigen.

set PDF = Nothing

Zusätzliche Form Field Funktionen

1. GetFormFieldTitle(FieldID) gibt den Formularfeldtitel einer bestimmten Feld-ID zurück.

2. get_fieldValue_byTitle(FormFieldTitle) gibt direkt den Wert eines bestimmten Formularfeldes zurück ohne es zuvor auszuwählen.

3. SetFormFieldValue_by_Name(FormFieldTitle, NewValue) setzt den Wert eines Formularfeldes nach Titel. Dies funktioniert direkt, ohne dass man das Feld vorher auswählen muss.

4. SetFormFieldValue_by_ID(FieldID, NewValue) setzt den Wert eines Formularfeldes nach ID. Dies funktioniert direkt, ohne dass man das Feld vorher auswählen muss.

5. seal_all_fields verschließt alle Formularfelder.
6. sealform(FieldID) verschließt/versiegelt ein bestimmtes Formularfeld.

7. set_formFieldReadOnly(FieldID) setzt einen Schreibschutz auf ein Formularfeld.

8. make_all_fields_readonly Alle Formularfelder mit Schreibschutz versehen.

9. delete_formfield Formularfeld anhand der ID löschen

10. set_FormFieldVisible kann dazu verwendet werden, ein Formularfeld sichtbar oder unsichtbar zu machen.

11. set_formfield_color setzt die Farbe des Formularfeldes.
12. set_formfield_bordertype definiert die Rahmenart eines Formularfeldes.

13. set_formfield_position setzt oder bewegt ein Formularfeld an eine bestimmte Position.

14. Submit_Button_Create erzeugt einen Button um XML-Daten an einen Webserver zu senden.

15. Submit_Button_set_URL definiert das Ziel von 14.

16. is_button checks falls ein Formulartype vom Typ button ist

17. change_FieldCaption ändert die Beschriftung eines Feldes. Beispielsweise den Text auf einem Button.


Home / Support / Aloaha PDF SDK / PDF Formular API