getFieldType (PdfUtils)

Versionshinweise

21.1, 20.2.03, 20.1.10, 19.2.16

Code

String getFieldType(PdfDocument pdfDocument, String fieldName) throws Exception

Beschreibung

Parameter

Ermittelt den Feldtyp für den übergebenen Feldnamen. 

  • pdfDocument
    Repräsentiert das PDF Dokument

  • fieldName
    Name des Feldes für den der Feldtyp ermittelt werden soll.

Rückgabe

Die unterstützten Feldtypen stehen als Konstanten in PdfConstants zur Verfügung. Folgende Feldtypen werden unterstützt.

  • PdfConstants.PDF_FIELDTYPE_TEXTBOX

  • PdfConstants.PDF_FIELDTYPE_RICHTEXTBOX   (für formatierten Text)

  • PdfConstants.PDF_FIELDTYPE_CHECKBOX

  • PdfConstants.PDF_FIELDTYPE_COMBOBOX

  • PdfConstants.PDF_FIELDTYPE_RADIOBUTTONOPTION

  • Nicht unterstützte Typen werden mit einem Infohinweis versehen, z.B. "Not supported fieldType: SignatureField"

Exception 
Wird im Regelfall geworfen, wenn im PDF Dokument kein Feld mit dem angegebenen Feldnamen vorhanden ist.

Beispiele

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

try
{
  pdfDocument = pdfResult.getPdfDocument();
  if (PdfUtils.existsField(pdfDocument, "myRadioButton"))
  {
    String fieldType = PdfUtils.getFieldType(pdfDocument, "myRadioButton");
    ...
  }
} 
catch (Exception dpe)
{
  ScriptUtils.logException(dpe);
}
finally
{
 if (pdfDocument!=null)
 {
    PdfUtils.close(pdfDocument);
 }
}