Struct ProtectedRange 

pub struct ProtectedRange {
    pub name: String,
    pub range: String,
    pub password: Option<String>,
}

One named, independently-passworded protected range (<protectedRange>, CT_ProtectedRange) — point 51, see Sheet::protected_ranges’s doc comment for how this differs from SheetProtection. Confirmed against sml.xsd: name/sqref are the only required attributes; password uses the same legacy 16-bit hash as SheetProtection/WorkbookProtection (see writer.rs::legacy_password_hash’s doc comment) — the newer SHA-512 algorithmName/hashValue/saltValue/spinCount form and the optional securityDescriptor child/attribute (a Windows ACL-based alternative to a password) are not modeled, same “one well-defined mechanism, not every historical Excel option” posture as SheetProtection.

Fields

name: String

This range’s name, shown in Excel’s “Allow Users to Edit Ranges” dialog (must be unique within the sheet, not validated here).

range: String

The range this entry covers (sqref, e.g. "B2:D10") — like IgnoredError::range, several disjoint cells can be packed into one sqref (space-separated) if the caller wants a single named range to cover them.

password: Option<String>

The password unlocking this range while the sheet is otherwise protected, in plain text — hashed into the legacy 16-bit form on write, never stored or written in plain text (same one-way posture as SheetProtection::password). None leaves the range editable by anyone once the sheet itself is protected (no password prompt), same as SheetProtection::password’s None case.

Implementations

impl ProtectedRange

pub fn new(name: impl Into<String>, range: impl Into<String>) -> ProtectedRange

Creates a named protected range with no password.

Examples found in repository

examples/xlsx_protection.rs (line 29)

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>) -> ProtectedRange

Sets a password and returns the range for chaining.

Examples found in repository

examples/xlsx_protection.rs (line 29)

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 ProtectedRange

fn clone(&self) -> ProtectedRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtectedRange

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

Formats the value using the given formatter.

impl PartialEq for ProtectedRange

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ProtectedRange