openFile

Code

ISpreadsheetResultOpen openFile(String fileName, SpreadsheetOptions options)

Beschreibung

Öffnet eine bestehende Tabellenkalkulationsdatei. Folgende Eingabeformate werden hierbei unterstützt:

• Microsoft Excel: XLS, XLSX, XLSB, XLTX, XLTM, XLSM, XML
• OpenOffice: ODS
• Text: CSV, Tab-Delimited, TXT

Parameter

• fileName
  Name der zu öffnenden Tabellenkalkulationsdatei (mit vollständiger Pfadangabe). Die angegebene Tabellenkalkulationsdatei muss vorhanden sein.
• options
  Optionaler Parameter für das Öffnen von Excel und textbasierten Tabellenkalkulationsdateien, z.B. csv. Im Falle von textbasierten Dateien können sowohl Separator als auch Zeichensatz der Textdatei beim Auslesen angegeben werden. Im Falle von Exceldateien wird der Parameter Passwort zur Entschlüsselung der Exceldatei verwendet.
  
  

Rückgabe
Ergebnis des Öffnens der Tabellenkalkulationsdatei.
Folgende Methoden stehen in dem Rückgabeobjekt ISpreadsheetResultOpen zur Verfügung

• Spreadsheet getSpreadsheet() 
  Repräsentiert die Tabellenkalkulationsdatei
• String getFileName()
  Liefert den Namen der geöffneten Tabellenkalkulationsdatei (entspricht dem übergebenen Parameter "fileName")
• boolean isSuccessful() 
  War das Öffnen der Tabellenkalkulationsdatei erfolgreich?
• String getErrorCode() 
  Liefert den Fehlercode, falls das Öffnen der Tabellenkalkulationsdatei nicht erfolgreich war. Die Fehlercodes stehen als Konstanten in der Klasse SpreadsheetUtils zur Verfügung, z.B.SpreadsheetUtils.SPREADSHEET_ERRORCODE_GENERAL Mit Hilfe der Fehlercodes können individuelle Ausgaben im Scripting hinterlegt werden. Folgende Fehlercodes stehen zur Verfügung:
  • SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_NOTFOUND
    Die angegebene Datei konnte nicht gefunden werden.
  • SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_NOTSUPPORTED
    Dieser Dateityp wird als Tabellenkalkulationsdatei nicht unterstützt.
  • SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_PASSWORDPROTECTED
    Die angegebene Datei ist mit einem Passwortschutz versehen.
  • SpreadsheetUtils.SPREADSHEET_ERRORCODE_GENERAL
    Ein allgemeiner Fehler ist bei der Bearbeitung der Tabellenkalkulationsdatei aufgetreten.

Beispiele

ISpreadsheetResultOpen openResult = SpreadsheetUtils.openFile("C:\\Work\\myFirstSpreadsheet.xlsm");

if (!openResult.isSuccessful())
{
    String errorCode = openResult.getErrorCode();
    
    if (SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_NOTFOUND.equals(errorCode))
    {
      //...handle FILE_NOTFOUND
      ScriptUtils.debug("Error: Die angegebene Exceldatei " + openResult.getFileName() + " konnte nicht gefunden werden.");
    }
    else if (SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_NOTSUPPORTED.equals(errorCode))
    {
      //... handle FILE_NOTSUPPORTED
    }
    else if (SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_PASSWORDPROTECTED.equals(errorCode))
    {
      //....handle FILE_PASSWORDPROTECTED
    }
    else
    {
      //....handle SPREADSHEET_ERRORCODE_GENERAL
    }
	/** do furthermore */
    return;
}

Spreadsheet excel = null;
try
{
  excel = openResult.getSpreadsheet();
  ...
}
finally
{
  SpreadsheetUtils.close(excel);
}