Struct SheetProtection 

pub struct SheetProtection {
    pub password: Option<String>,
}

A sheet’s protection settings (<sheetProtection>, CT_SheetProtection). Only the legacy 16-bit password hash (password="XXXX", still fully understood by every version of Excel even though the UI has written the newer SHA-512 hashValue/saltValue/spinCount form since Excel 2013 — see writer.rs::legacy_password_hash’s doc comment) is modeled. Every other CT_SheetProtection flag (formatCells/insertRows/sort/ autoFilter/objects/..) is left at Excel’s own schema default — this crate only ever writes sheet="1" and, if set, password, matching what checking Excel’s own “Protect Sheet” dialog with no extra options touched produces.

Fields

password: Option<String>

The password, in plain text — hashed into the legacy 16-bit form on write; never stored or written in plain text anywhere in the output file. None protects the sheet with no password at all (Excel’s “Protect Sheet” with a blank password field — still blocks accidental edits through the UI, but anyone can immediately remove the protection since there’s nothing to check a password against).

Implementations

impl SheetProtection

pub fn locked() -> SheetProtection

Protects the sheet with no password.

Examples found in repository

examples/xlsx_protection.rs (line 28)

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(password: impl Into<String>) -> SheetProtection

Protects the sheet with a password.

Examples found in repository

examples/xlsx_protection.rs (line 21)

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 SheetProtection

fn clone(&self) -> SheetProtection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SheetProtection

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

Formats the value using the given formatter.

impl PartialEq for SheetProtection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SheetProtection