Struct WorkbookProtection 

pub struct WorkbookProtection {
    pub password: Option<String>,
    pub lock_structure: bool,
    pub lock_windows: bool,
}

Workbook structure protection (<workbookProtection>, CT_WorkbookProtection). Locks whether sheets can be added/renamed/hidden/reordered/deleted (lockStructure) and/or whether the workbook’s window can be moved/resized/closed (lockWindows) — distinct from SheetProtection, which locks cell editing within one sheet. Uses the same legacy 16-bit password hash as SheetProtection (see writer.rs::legacy_password_hash’s doc comment for the algorithm and its caveats) — implemented but not yet verified against a real Excel installation.

Fields

password: Option<String>

The password, in plain text — hashed on write, never recoverable on read (same one-way posture as SheetProtection::password).

lock_structure: bool

Locks the workbook’s structure (adding/renaming/hiding/reordering/ deleting sheets).

lock_windows: bool

Locks the workbook’s window (moving/resizing/closing).

Implementations

impl WorkbookProtection

pub fn locked() -> WorkbookProtection

Locks the workbook’s structure, no password, windows not locked.

Examples found in repository

examples/xlsx_protection.rs (line 44)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_protection.xlsx");

    let sheet_protection_sheet = Sheet::new("Sheet protection")
        .with_row(Row::new().with_text("Locked: this sheet is protected with a password."))
        .with_protection(SheetProtection::with_password("secret"));

    let protected_range_sheet = Sheet::new("Protected range")
        .with_row(
            Row::new()
                .with_text("A1 is protected; B1 stays editable via a named unprotected range."),
        )
        .with_protection(SheetProtection::locked())
        .with_protected_range(ProtectedRange::new("EditableArea", "B1:B1").with_password("secret"));

    let workbook = Workbook::new()
        .with_write_protection(
            WriteProtection::recommended()
                .with_user_name("Author")
                .with_password("secret"),
        )
        .with_sheet(sheet_protection_sheet)
        .with_sheet(protected_range_sheet);

    // `Workbook.protection` (structure protection: locking sheet
    // add/rename/hide/reorder/delete) has no `with_*` builder — it's set
    // directly, like any other public field.
    let workbook = Workbook {
        protection: Some(WorkbookProtection::locked().with_lock_windows(true)),
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

pub fn with_password(self, password: impl Into<String>) -> WorkbookProtection

Sets a password and returns the protection for chaining.

pub fn with_lock_windows(self, lock_windows: bool) -> WorkbookProtection

Sets whether the workbook’s window is locked and returns the protection for chaining.

Examples found in repository

examples/xlsx_protection.rs (line 44)

fn main() -> office_toolkit::Result<()> {
    let path = output_path("xlsx_protection.xlsx");

    let sheet_protection_sheet = Sheet::new("Sheet protection")
        .with_row(Row::new().with_text("Locked: this sheet is protected with a password."))
        .with_protection(SheetProtection::with_password("secret"));

    let protected_range_sheet = Sheet::new("Protected range")
        .with_row(
            Row::new()
                .with_text("A1 is protected; B1 stays editable via a named unprotected range."),
        )
        .with_protection(SheetProtection::locked())
        .with_protected_range(ProtectedRange::new("EditableArea", "B1:B1").with_password("secret"));

    let workbook = Workbook::new()
        .with_write_protection(
            WriteProtection::recommended()
                .with_user_name("Author")
                .with_password("secret"),
        )
        .with_sheet(sheet_protection_sheet)
        .with_sheet(protected_range_sheet);

    // `Workbook.protection` (structure protection: locking sheet
    // add/rename/hide/reorder/delete) has no `with_*` builder — it's set
    // directly, like any other public field.
    let workbook = Workbook {
        protection: Some(WorkbookProtection::locked().with_lock_windows(true)),
        ..workbook
    };

    workbook.save_to_file(&path)?;
    println!("Wrote {}", path.display());
    Ok(())
}

Trait Implementations

impl Clone for WorkbookProtection

fn clone(&self) -> WorkbookProtection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkbookProtection

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for WorkbookProtection

fn eq(&self, other: &WorkbookProtection) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WorkbookProtection