Struct DocumentProperties 

pub struct DocumentProperties {
    pub title: Option<String>,
    pub author: Option<String>,
    pub subject: Option<String>,
    pub keywords: Option<String>,
    pub company: Option<String>,
    pub manager: Option<String>,
    pub hyperlink_base: Option<String>,
    pub custom_properties: Vec<(String, CustomPropertyValue)>,
}

Document metadata (docProps/core.xml’s Dublin Core fields plus docProps/app.xml’s Company/Manager/HyperlinkBase, and docProps/custom.xml’s user-defined properties) — extended by. Before both core.xml/app.xml were always written but always empty/boilerplate (see writer.rs’s to_core_properties_xml/ to_app_properties_xml). Only the handful of fields a real document typically carries are modeled — docProps/core.xml’s lastModifiedBy/revision/created/modified/category/contentStatus are still not.

Fields

title: Option<String>

docProps/core.xml’s <dc:title>.

author: Option<String>

docProps/core.xml’s <dc:creator>.

subject: Option<String>

docProps/core.xml’s <dc:subject>.

keywords: Option<String>

docProps/core.xml’s <cp:keywords>.

company: Option<String>

docProps/app.xml’s <Company>.

manager: Option<String>

docProps/app.xml’s <Manager>.

hyperlink_base: Option<String>

docProps/app.xml’s <HyperlinkBase> (the base URL relative hyperlinks in this workbook resolve against) — point 57.

custom_properties: Vec<(String, CustomPropertyValue)>

User-defined custom document properties (docProps/custom.xml, CT_Properties/CT_Property) — point 56, visible in Excel’s File > Info > Properties > Advanced Properties > Custom tab. A Vec of (name, value) pairs, not a map: insertion order is preserved and determines the sequential pid each entry gets when written (2, 3, 4. — 0/1 are reserved by the format and never assigned), matching word-ooxml’s own Document.custom_properties convention exactly (including which 4 CustomPropertyValue variants are modeled, for consistency across this workspace’s crates). Only written if non-empty, same “optional part” posture as table_styles/external_links elsewhere in this crate.

Implementations

impl DocumentProperties

pub fn new() -> DocumentProperties

Creates document properties with every field unset (equivalent to DocumentProperties::default(), only useful as a starting point for the with_* builders).

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 68)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

pub fn with_title(self, title: impl Into<String>) -> DocumentProperties

Sets the title and returns the properties for chaining.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 69)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

pub fn with_author(self, author: impl Into<String>) -> DocumentProperties

Sets the author and returns the properties for chaining.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 70)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

pub fn with_subject(self, subject: impl Into<String>) -> DocumentProperties

Sets the subject and returns the properties for chaining.

Examples found in repository

examples/xlsx_workbook_metadata.rs (line 71)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

pub fn with_keywords(self, keywords: impl Into<String>) -> DocumentProperties

Sets the keywords and returns the properties for chaining.

pub fn with_company(self, company: impl Into<String>) -> DocumentProperties

Sets the company and returns the properties for chaining.

pub fn with_manager(self, manager: impl Into<String>) -> DocumentProperties

Sets the manager and returns the properties for chaining.

pub fn with_hyperlink_base( self, hyperlink_base: impl Into<String>, ) -> DocumentProperties

Sets the hyperlink base and returns the properties for chaining — point 57.

pub fn with_custom_property( self, name: impl Into<String>, value: CustomPropertyValue, ) -> DocumentProperties

Appends a custom document property and returns the properties for chaining. See custom_properties’s doc comment for why order matters (it determines each entry’s pid).

Examples found in repository

examples/xlsx_workbook_metadata.rs (lines 72-75)

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

    let named_ranges_sheet = Sheet::new("Named ranges")
        .with_row(Row::new().with_text("Tax rate").with_number(0.0825))
        .with_row(Row::new().with_cell(Cell::formula("TaxRate*100").with_cached_value(8.25)));

    let calculation_sheet = Sheet::new("Calculation").with_row(
        Row::new().with_text("Set to manual recalculation with iterative calculation enabled."),
    );

    let scenarios_sheet = Sheet::new("Scenarios")
        .with_row(Row::new().with_text("Revenue").with_number(100_000.0))
        .with_row(Row::new().with_text("Cost").with_number(60_000.0))
        .with_scenario(
            Scenario::new("Best case")
                .with_input("B1", "150000")
                .with_input("B2", "55000")
                .with_comment("Optimistic projection"),
        )
        .with_scenario(
            Scenario::new("Worst case")
                .with_input("B1", "70000")
                .with_input("B2", "65000"),
        );

    let auto_filter_sheet = Sheet::new("Autofilter criteria")
        .with_row(Row::new().with_text("Region"))
        .with_row(Row::new().with_text("North"))
        .with_row(Row::new().with_text("South"))
        .with_auto_filter_range("A1:A3")
        .with_auto_filter_column(AutoFilterColumn::new(0, vec!["North".to_string()]));

    let ignored_errors_sheet = Sheet::new("Ignored errors")
        .with_row(Row::new().with_text("123")) // a number stored as text — normally flagged by Excel
        .with_ignored_error(IgnoredError::new("A1:A1").with_number_stored_as_text(true));

    let workbook = Workbook::new()
        .with_defined_name(DefinedName::new("TaxRate", "'Named ranges'!$B$1"))
        .with_calculation(
            CalculationProperties::new()
                .with_mode(CalculationMode::Manual)
                .with_iterate(true),
        )
        .with_sheet(named_ranges_sheet)
        .with_sheet(calculation_sheet)
        .with_sheet(scenarios_sheet)
        .with_sheet(auto_filter_sheet)
        .with_sheet(ignored_errors_sheet);

    // `Workbook.properties` has no `with_*` builder — it's set directly,
    // like any other public field.
    let properties = DocumentProperties::new()
        .with_title("Metadata example")
        .with_author("Example Author")
        .with_subject("Workbook-level features")
        .with_custom_property(
            "ProjectCode",
            CustomPropertyValue::Text("XLSX-META".to_string()),
        );
    let workbook = Workbook {
        properties,
        ..workbook
    };

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

Trait Implementations

impl Clone for DocumentProperties

fn clone(&self) -> DocumentProperties

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentProperties

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

Formats the value using the given formatter.

impl Default for DocumentProperties

fn default() -> DocumentProperties

Returns the “default value” for a type.

impl PartialEq for DocumentProperties

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentProperties