openFile (PdfUtils)

Code

IPdfResult openFile(String pdfFileName)

Beschreibung

Öffnet eine bestehende PDF Datei. 

Parameter

• pdfFileName
  Name der zu öffnenden PDF Datei (mit vollständiger Pfadangabe). Die angegebene PDF Datei muss vorhanden sein.
  
  

Rückgabe
Ergebnis des Öffnens der PDF Datei.
Folgende Methoden stehen in dem Rückgabeobjekt IPdfResult zur Verfügung

• PdfDocument getPdfDocument() 
  Repräsentiert das PDF Dokument
• String getFileName()
  Liefert den Namen der geöffneten PDF Datei (entspricht dem übergebenen Parameter "fileName")
• boolean isSuccessful() 
  War das Öffnen der PDF Datei erfolgreich?
• String getErrorCode() 
  Liefert den Fehlercode, falls das Öffnen der PDF Datei nicht erfolgreich war. Die Fehlercodes stehen als Konstanten in der Klasse PdfConstants zur Verfügung, z.B.SpreadsheetUtils.SPREADSHEET_ERRORCODE_GENERAL Mit Hilfe der Fehlercodes können individuelle Ausgaben im Skripting hinterlegt werden. Folgende Fehlercodes stehen zur Verfügung:
  • PdfConstants.PDF_ERRORCODE_FILENOTFOUND
    Die angegebene Datei konnte nicht gefunden werden.
  • PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE
    Dieser Dateityp wird als PDF Dokument nicht unterstützt.
  • PdfConstants.PDF_ERRORCODE_GENERAL
    Ein allgemeiner Fehler ist beim Öffnen der PDF Datei aufgetreten.

Beispiele

IPdfResult openResult = PdfUtils.openFile("C:\\Work\\myPDF.pdf");
if (!openResult.isSuccessful())
{
    String errorCode = openResult.getErrorCode();
    
    if (PdfConstants.PDF_ERRORCODE_FILENOTFOUND.equals(errorCode))
    {
      //...handle FILE_NOTFOUND
      ScriptUtils.debug("Error: Die angegebene PDF Datei " + openResult.getFileName() + " konnte nicht gefunden werden.");
    }
    else if (PdfConstants.PDF_ERRORCODE_NOTSUPPORTED_FILETYPE.equals(errorCode))
    {
      //... handle FILE_NOTSUPPORTED
    }
    else
    {
      //....handle PdfConstants.PDF_ERRORCODE_GENERAL
    }
	/** do furthermore */
    return;
}
PdfDocument pdfDocument = null;

try
{
      pdfDocument = pdfResult.getPdfDocument();
      PdfUtils.setFieldValue(pdfDocument, "myTextBox", "der neue Wert");
      PdfUtils.savePdf(pdfDocument);
}
catch (Exception dpe)
{
        ScriptUtils.logException(dpe);
}
finally
{
      if (pdfDocument!=null)
      {
        PdfUtils.closePdf(pdfDocument);
      }
}