getFieldNames (PdfUtils)

Code

List<String> getFieldNames(PdfDocument pdfDocument, String... fieldTypes) throws Exception

Beschreibung

Ermittelt alle Felder, deren Feldtyp in der Liste der übergebenen Feldtypen enthalten ist. Es werden die Namen der ermittelten Felder als Liste zurückgegeben.

Parameter

• pdfDocument
  Repräsentiert das PDF Dokument
• fieldTypes
  Optionaler Parameter zum  Filtern der ermittelten Felder.
  Die unterstützten Feldtypen stehen als Konstanten in PdfConstants zur Verfügung, z.B. PdfConstants.PDF_FIELDTYPE_TEXTBOX, PdfConstants.PDF_FIELDTYPE_CHECKBOX, u.a.
  Wird der Parameter nicht übergeben, so werden alle Felder ermittelt. 

Rückgabe

Es werden die Namen der ermittelten Felder als Liste zurückgegeben.

Exception 
Wird geworfen, wenn die Aktion nicht erfolgreich ausgeführt werden konnte.

Beispiele

IPdfResult openResult = PdfUtils.openFile("C:\\Work\\myPDF.pdf");
...
PdfDocument pdfDocument = null;

try
{
  pdfDocument = pdfResult.getPdfDocument();
  List allFieldNames = PdfUtils.getFieldNames(pdfDocument);
  List fieldNames = PdfUtils.getFieldNames(pdfDocument, PdfConstants.PDF_FIELDTYPE_TEXTBOX, PdfConstants.PDF_FIELDTYPE_CHECKBOX);
  ...
}
catch (Exception dpe)
{
  ScriptUtils.logException(dpe);
}
finally
{
 if (pdfDocument!=null)
 {
    PdfUtils.close(pdfDocument);
 }
}