Skip to main content
Skip table of contents

setPassword

Versionshinweise

21.2

Code

GROOVY
void setPassword(SpreadsheetOptions options, String password)

Beschreibung

Setzen oder Entfernen des Passwortschutzes für eine Exceldatei mit Hilfe der SpreadsheetOptions.
Für das Entfernen eines bestehenden Passwortschutzes ist analog zu Microsoft Excel ein Leerwert (null oder "") zu übergeben.


Parameter

  • options
    Objekt zum Steuern des Ladens und Speicherns einer Tabellenkalkulationsdatei
  • password
    Passwort für die verschlüsselte Exceldatei.
    Für das Entfernen eines bestehenden Passwortschutzes ist analog zu Microsoft Excel ein Leerwert (null oder "") zu übergeben.

Beispiele

GROOVY
/* Example for setting and removing password protection for an excel file */

/* First create options for loading password encrypted excel file  */
SpreadsheetOptions loadOptions = SpreadsheetUtils.createOptions();
SpreadsheetUtils.setPassword(loadOptions, "4711");

ISpreadsheetResultOpen openResult = SpreadsheetUtils.openFile("C:\\Work\\SpreadsheetWithPassword.xlsx", loadOptions);
if (!openResult.isSuccessful())
{
    String errorCode = openResult.getErrorCode();

    if (SpreadsheetUtils.SPREADSHEET_ERRORCODE_FILE_PASSWORDPROTECTED.equals(errorCode))
    {
      //....handle FILE_PASSWORDPROTECTED
    }
    else
    {
      //....handle further error codes, e.g. SPREADSHEET_ERRORCODE_GENERAL
    }
    /** do furthermore */
    return;
}

try
{
	Spreadsheet excel = openResult.getSpreadsheet();
	/* Now remove password from encrypted excel file per options */
	SpreadsheetOptions saveOptions = SpreadsheetUtils.createOptions();
	SpreadsheetUtils.setPassword(saveOptions, null);
	SpreadsheetUtils.save(excel, saveOptions);
	/* Password encryption for excel file is now removed */
	...
}
finally
{
	SpreadsheetUtils.close(excel);
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.