UmyaSpreadsheet.WorkbookProtectionFunctions (umya_spreadsheet_ex v0.7.0)

View Source

Functions for managing workbook protection settings and retrieving protection status.

Excel workbooks can be protected to prevent structural changes, window modifications, or revision tracking. This module provides functions to:

  • Check if workbook protection is enabled
  • Retrieve protection settings and status
  • Enable/disable various protection features

Summary

Functions

get_workbook_protection_details(spreadsheet)

Gets detailed information about workbook protection settings.

is_workbook_protected(spreadsheet)

Checks if the workbook has protection enabled.

Functions

get_workbook_protection_details(spreadsheet)

Gets detailed information about workbook protection settings.

Parameters

  • spreadsheet - The spreadsheet struct

Returns

  • {:ok, protection_details} where protection_details is a map containing protection settings:
    • "lock_structure" - "true" if structure changes are prevented
    • "lock_windows" - "true" if window changes are prevented
    • "lock_revision" - "true" if revision tracking is enabled
  • {:error, reason} if the workbook is not protected or on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("protected.xlsx")
{:ok, details} = UmyaSpreadsheet.WorkbookProtectionFunctions.get_workbook_protection_details(spreadsheet)
# details = %{
#   "lock_structure" => "true",
#   "lock_windows" => "true",
#   "lock_revision" => "false"
# }

is_workbook_protected(spreadsheet)

Checks if the workbook has protection enabled.

Parameters

  • spreadsheet - The spreadsheet struct

Returns

  • {:ok, is_protected} where is_protected is a boolean indicating if protection is enabled
  • {:error, reason} on failure

Examples

{:ok, spreadsheet} = UmyaSpreadsheet.read_file("input.xlsx")
{:ok, protected} = UmyaSpreadsheet.WorkbookProtectionFunctions.is_workbook_protected(spreadsheet)
# protected = true (if workbook is protected)