Package com.grapecity.documents.excel

Interface IProtectionSettings

public interface IProtectionSettings
Represents the various types of protection options available for a worksheet. The setting action will take effect only if the worksheet is under protection.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fromJson(String json)
    Generate the ProtectionOptions from json string.
    boolean
    getAllowDeletingColumns()
    Gets whether the deletion of columns is allowed on a protected worksheet.
    boolean
    getAllowDeletingRows()
    Gets whether the deletion of rows is allowed on a protected worksheet.
    boolean
    getAllowEditingScenarios()
    Gets whether the user is allowed to edit scenarios on a protected worksheet.
    boolean
    getAllowFiltering()
    Gets whether the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
    boolean
    getAllowFormattingCells()
    Gets whether the formatting of cells is allowed on a protected worksheet.
    boolean
    getAllowFormattingColumns()
    Gets whether the formatting of columns is allowed on a protected worksheet.
    boolean
    getAllowFormattingRows()
    Gets whether the formatting of rows is allowed on a protected worksheet.
    boolean
    getAllowInsertingColumns()
    Gets whether the insertion of columns is allowed on a protected worksheet.
    boolean
    getAllowInsertingHyperlinks()
    Gets whether the insertion of hyperlinks is allowed on a protected worksheet.
    boolean
    getAllowInsertingRows()
    Gets whether the insertion of rows is allowed on a protected worksheet.
    boolean
    getAllowSorting()
    Gets whether the sorting option is allowed on a protected worksheet.
    boolean
    getAllowUsingObjects()
    Gets whether the user is allowed to use objects on a protected worksheet.
    boolean
    getAllowUsingPivotTables()
    Gets whether the user is allowed to use pivot tables on a protected worksheet.
    void
    setAllowDeletingColumns(boolean value)
    Sets whether the deletion of columns is allowed on a protected worksheet.
    void
    setAllowDeletingRows(boolean value)
    Sets whether the deletion of rows is allowed on a protected worksheet.
    void
    setAllowEditingScenarios(boolean value)
    Sets whether the user is allowed to edit scenarios on a protected worksheet.
    void
    setAllowFiltering(boolean value)
    Sets whether the user is allowed to make use of an AutoFilter that was created before the sheet was protected.
    void
    setAllowFormattingCells(boolean value)
    Sets whether the formatting of cells is allowed on a protected worksheet.
    void
    setAllowFormattingColumns(boolean value)
    Sets whether the formatting of columns is allowed on a protected worksheet.
    void
    setAllowFormattingRows(boolean value)
    Sets whether the formatting of rows is allowed on a protected worksheet.
    void
    setAllowInsertingColumns(boolean value)
    Sets whether the insertion of columns is allowed on a protected worksheet.
    void
    setAllowInsertingHyperlinks(boolean value)
    Sets whether the insertion of hyperlinks is allowed on a protected worksheet.
    void
    setAllowInsertingRows(boolean value)
    Sets whether the insertion of rows is allowed on a protected worksheet.
    void
    setAllowSorting(boolean value)
    Sets whether the sorting option is allowed on a protected worksheet.
    void
    setAllowUsingObjects(boolean value)
    Sets whether the user is allowed to use objects on a protected worksheet.
    void
    setAllowUsingPivotTables(boolean value)
    Sets whether the user is allowed to use pivot tables on a protected worksheet.
    String
    toJson()
    Generate the string from the ProtectionOptions.

  • Method Details

    • getAllowDeletingColumns

      boolean getAllowDeletingColumns()
      Gets whether the deletion of columns is allowed on a protected worksheet.

    • setAllowDeletingColumns

      void setAllowDeletingColumns(boolean value)
      Sets whether the deletion of columns is allowed on a protected worksheet.

    • getAllowDeletingRows

      boolean getAllowDeletingRows()
      Gets whether the deletion of rows is allowed on a protected worksheet.

    • setAllowDeletingRows

      void setAllowDeletingRows(boolean value)
      Sets whether the deletion of rows is allowed on a protected worksheet.

    • getAllowFiltering

      boolean getAllowFiltering()
      Gets whether the user is allowed to make use of an AutoFilter that was created before the sheet was protected.

    • setAllowFiltering

      void setAllowFiltering(boolean value)
      Sets whether the user is allowed to make use of an AutoFilter that was created before the sheet was protected.

    • getAllowFormattingCells

      boolean getAllowFormattingCells()
      Gets whether the formatting of cells is allowed on a protected worksheet.

    • setAllowFormattingCells

      void setAllowFormattingCells(boolean value)
      Sets whether the formatting of cells is allowed on a protected worksheet.

    • getAllowFormattingColumns

      boolean getAllowFormattingColumns()
      Gets whether the formatting of columns is allowed on a protected worksheet.

    • setAllowFormattingColumns

      void setAllowFormattingColumns(boolean value)
      Sets whether the formatting of columns is allowed on a protected worksheet.

    • getAllowFormattingRows

      boolean getAllowFormattingRows()
      Gets whether the formatting of rows is allowed on a protected worksheet.

    • setAllowFormattingRows

      void setAllowFormattingRows(boolean value)
      Sets whether the formatting of rows is allowed on a protected worksheet.

    • getAllowInsertingColumns

      boolean getAllowInsertingColumns()
      Gets whether the insertion of columns is allowed on a protected worksheet.

    • setAllowInsertingColumns

      void setAllowInsertingColumns(boolean value)
      Sets whether the insertion of columns is allowed on a protected worksheet.

    • getAllowInsertingRows

      boolean getAllowInsertingRows()
      Gets whether the insertion of rows is allowed on a protected worksheet.

    • setAllowInsertingRows

      void setAllowInsertingRows(boolean value)
      Sets whether the insertion of rows is allowed on a protected worksheet.

    • getAllowInsertingHyperlinks

      boolean getAllowInsertingHyperlinks()
      Gets whether the insertion of hyperlinks is allowed on a protected worksheet.

    • setAllowInsertingHyperlinks

      void setAllowInsertingHyperlinks(boolean value)
      Sets whether the insertion of hyperlinks is allowed on a protected worksheet.

    • getAllowSorting

      boolean getAllowSorting()
      Gets whether the sorting option is allowed on a protected worksheet.

    • setAllowSorting

      void setAllowSorting(boolean value)
      Sets whether the sorting option is allowed on a protected worksheet.

    • getAllowUsingPivotTables

      boolean getAllowUsingPivotTables()
      Gets whether the user is allowed to use pivot tables on a protected worksheet.

    • setAllowUsingPivotTables

      void setAllowUsingPivotTables(boolean value)
      Sets whether the user is allowed to use pivot tables on a protected worksheet.

    • getAllowUsingObjects

      boolean getAllowUsingObjects()
      Gets whether the user is allowed to use objects on a protected worksheet.

    • setAllowUsingObjects

      void setAllowUsingObjects(boolean value)
      Sets whether the user is allowed to use objects on a protected worksheet.

    • getAllowEditingScenarios

      boolean getAllowEditingScenarios()
      Gets whether the user is allowed to edit scenarios on a protected worksheet. The default value is false.

    • setAllowEditingScenarios

      void setAllowEditingScenarios(boolean value)
      Sets whether the user is allowed to edit scenarios on a protected worksheet.

    • fromJson

      void fromJson(String json)
      Generate the ProtectionOptions from json string.
      Parameters:
      json - The JSON string representing the ProtectionOptions.

    • toJson

      String toJson()
      Generate the string from the ProtectionOptions.
      Returns:
      The JSON string representing the ProtectionOptions.