setVisibleWorksheet

Versionshinweise

21.2

Code

Groovy
boolean setVisibleWorksheet(Spreadsheet spreadsheet, String sheetName, boolean visible)
boolean setVisibleWorksheet(Spreadsheet spreadsheet, int sheetIndex, boolean visible)

Beschreibung

Steuern der Sichtbarkeit des Arbeitsblatts in der übergebenen Tabellenkalkulationsdatei.

Parameter

  • spreadsheet
    Repräsentiert die Tabellenkalkulationsdatei

  • sheetName
    Name des Arbeitsblattes (z.B. "CONFIG")

  • sheetIndex
    Numerischer Index des Arbeitsblattes innerhalb der Tabellenkalkulationsdatei (das erste Arbeitsblatt beginnt mit 1)

  • visible
    sichtbar (true) oder ausgeblendet (false)

Rückgabe 
true - wenn die Sichtbarkeit des angegebenen Arbeitsblatt konfiguriert werden konnte. 
Im Regelfall wird false zurückgeliefert, wenn das angegebene Arbeitsblatt  in der Tabellenkalkulationsdatei nicht gefunden werden konnte.

Beispiele

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


if (!openResult.isSuccessful())
{
  ScriptUtils.debug("Error: " + openResult.getFileName() + " - " + openResult.getErrorCode());
  /* do furthermore */
  return;
}


Spreadsheet excel = null;
try
{
  excel = openResult.getSpreadsheet();
  // hide first worksheet
  SpreadsheetUtils.setVisibleWorksheet(excel, 1, false);

  // hide CONFIG worksheet
  SpreadsheetUtils.setVisibleWorksheet(excel, "CONFIG", false);
  ...
}
finally
{
  SpreadsheetUtils.close(excel);
}