Struct Workbook

pub struct Workbook { /* private fields */ }

Implementations

impl Workbook

pub fn new() -> Self

Create a new workbook. There is no need to give the file name at this place, because nothing gets written to disk yet, this will all be done when the write_file or write method gets called.

Examples found in repository

examples/hello.rs (line 4)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    let worksheet = workbook.add_worksheet(None)?;

    worksheet.write_string(index(0, 0)?, "Hello", None)?;
    worksheet.write_number(index(1, 0)?, 123.0, None).unwrap();

    workbook.write_file("hello_world.xlsx")?;

    Ok(())
}

examples/utf8.rs (line 4)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet = workbook.add_worksheet(None)?;
        worksheet.write_string(
            index(2, 1)?,
            "Это фраза на русском!",
            None,
        )?;
    }

    workbook.write_file("utf8.xlsx")?;

    Ok(())
}

examples/tab_colors.rs (line 5)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet1 = workbook.add_worksheet(None)?;
        worksheet1.set_tab_color(colors::RED);
    }
    {
        let worksheet2 = workbook.add_worksheet(None)?;
        worksheet2.set_tab_color(colors::GREEN);
    }
    {
        let worksheet3 = workbook.add_worksheet(None)?;
        worksheet3.set_tab_color(RGB8 {
            r: 0xff,
            g: 0x99,
            b: 0x00,
        });
    }
    {
        let worksheet4 = workbook.add_worksheet(None)?;
        worksheet4.write_string(index(0, 0)?, "Hello", None)?;
    }

    workbook.write_file("tab_colors.xlsx")?;

    Ok(())
}

examples/tutorial1.rs (line 31)

fn main() -> karo::Result<()> {
    let expenses = [
        Expense {
            item: "Rent",
            cost: 1000f64,
        },
        Expense {
            item: "Gas",
            cost: 100f64,
        },
        Expense {
            item: "Food",
            cost: 300f64,
        },
        Expense {
            item: "Gym",
            cost: 50f64,
        },
    ];

    // Create a new workbook.
    let mut workbook = Workbook::new();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        let mut row = 0u32;
        for Expense { item, cost } in expenses.iter() {
            worksheet.write_string(index(row, 0)?, item, None)?;
            worksheet.write_number(index(row, 1)?, *cost, None)?;
            row += 1;
        }

        worksheet.write_string(index(row, 0)?, "Total", None)?;
        worksheet.write_formula(index(row, 1)?, "=SUM(B1:B4)", None)?;
    }

    workbook.write_file("tutorial01.xlsx")?;

    Ok(())
}

examples/doc_custom_properties.rs (line 8)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

examples/doc_properties.rs (line 7)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    // This method returns an &mut DocProperties.
    let p = workbook.properties();
    p.title = "This is an example spreadsheet".to_string();
    p.subject = "With document properties".to_string();
    p.author = "Max Mustermann".to_string();
    p.manager = "Dr. Heinz Doofenshmirtz".to_string();
    p.company = "of Wolves".to_string();
    p.category = "Example spreadsheets".to_string();
    p.keywords = "Sample, Example, Properties".to_string();
    p.comments = "Created with karo".to_string();
    p.status = "Quo".to_string();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_properties.xlsx")?;

    Ok(())
}

Additional examples can be found in:

• examples/format_font.rs
• examples/tutorial2.rs
• examples/anatomy.rs
• examples/tutorial3.rs
• examples/format_num_format.rs
• examples/data_validate.rs

pub fn write_file<P: AsRef<Path>>(self, path: P) -> Result<()>

Examples found in repository

examples/hello.rs (line 11)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    let worksheet = workbook.add_worksheet(None)?;

    worksheet.write_string(index(0, 0)?, "Hello", None)?;
    worksheet.write_number(index(1, 0)?, 123.0, None).unwrap();

    workbook.write_file("hello_world.xlsx")?;

    Ok(())
}

examples/utf8.rs (line 15)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet = workbook.add_worksheet(None)?;
        worksheet.write_string(
            index(2, 1)?,
            "Это фраза на русском!",
            None,
        )?;
    }

    workbook.write_file("utf8.xlsx")?;

    Ok(())
}

examples/tab_colors.rs (line 28)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet1 = workbook.add_worksheet(None)?;
        worksheet1.set_tab_color(colors::RED);
    }
    {
        let worksheet2 = workbook.add_worksheet(None)?;
        worksheet2.set_tab_color(colors::GREEN);
    }
    {
        let worksheet3 = workbook.add_worksheet(None)?;
        worksheet3.set_tab_color(RGB8 {
            r: 0xff,
            g: 0x99,
            b: 0x00,
        });
    }
    {
        let worksheet4 = workbook.add_worksheet(None)?;
        worksheet4.write_string(index(0, 0)?, "Hello", None)?;
    }

    workbook.write_file("tab_colors.xlsx")?;

    Ok(())
}

examples/tutorial1.rs (line 48)

fn main() -> karo::Result<()> {
    let expenses = [
        Expense {
            item: "Rent",
            cost: 1000f64,
        },
        Expense {
            item: "Gas",
            cost: 100f64,
        },
        Expense {
            item: "Food",
            cost: 300f64,
        },
        Expense {
            item: "Gym",
            cost: 50f64,
        },
    ];

    // Create a new workbook.
    let mut workbook = Workbook::new();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        let mut row = 0u32;
        for Expense { item, cost } in expenses.iter() {
            worksheet.write_string(index(row, 0)?, item, None)?;
            worksheet.write_number(index(row, 1)?, *cost, None)?;
            row += 1;
        }

        worksheet.write_string(index(row, 0)?, "Total", None)?;
        worksheet.write_formula(index(row, 1)?, "=SUM(B1:B4)", None)?;
    }

    workbook.write_file("tutorial01.xlsx")?;

    Ok(())
}

examples/doc_custom_properties.rs (line 32)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

examples/doc_properties.rs (line 35)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    // This method returns an &mut DocProperties.
    let p = workbook.properties();
    p.title = "This is an example spreadsheet".to_string();
    p.subject = "With document properties".to_string();
    p.author = "Max Mustermann".to_string();
    p.manager = "Dr. Heinz Doofenshmirtz".to_string();
    p.company = "of Wolves".to_string();
    p.category = "Example spreadsheets".to_string();
    p.keywords = "Sample, Example, Properties".to_string();
    p.comments = "Created with karo".to_string();
    p.status = "Quo".to_string();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_properties.xlsx")?;

    Ok(())
}

Additional examples can be found in:

• examples/format_font.rs
• examples/tutorial2.rs
• examples/anatomy.rs
• examples/tutorial3.rs
• examples/format_num_format.rs
• examples/data_validate.rs

pub fn write<W: Write + Seek>(self, w: W) -> Result<()>

pub fn add_worksheet( &mut self, sheetname: Option<&str>, ) -> Result<&mut Worksheet>

Examples found in repository

examples/hello.rs (line 6)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    let worksheet = workbook.add_worksheet(None)?;

    worksheet.write_string(index(0, 0)?, "Hello", None)?;
    worksheet.write_number(index(1, 0)?, 123.0, None).unwrap();

    workbook.write_file("hello_world.xlsx")?;

    Ok(())
}

examples/utf8.rs (line 7)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet = workbook.add_worksheet(None)?;
        worksheet.write_string(
            index(2, 1)?,
            "Это фраза на русском!",
            None,
        )?;
    }

    workbook.write_file("utf8.xlsx")?;

    Ok(())
}

examples/tab_colors.rs (line 8)

fn main() -> karo::Result<()> {
    let mut workbook = Workbook::new();

    {
        let worksheet1 = workbook.add_worksheet(None)?;
        worksheet1.set_tab_color(colors::RED);
    }
    {
        let worksheet2 = workbook.add_worksheet(None)?;
        worksheet2.set_tab_color(colors::GREEN);
    }
    {
        let worksheet3 = workbook.add_worksheet(None)?;
        worksheet3.set_tab_color(RGB8 {
            r: 0xff,
            g: 0x99,
            b: 0x00,
        });
    }
    {
        let worksheet4 = workbook.add_worksheet(None)?;
        worksheet4.write_string(index(0, 0)?, "Hello", None)?;
    }

    workbook.write_file("tab_colors.xlsx")?;

    Ok(())
}

examples/tutorial1.rs (line 35)

fn main() -> karo::Result<()> {
    let expenses = [
        Expense {
            item: "Rent",
            cost: 1000f64,
        },
        Expense {
            item: "Gas",
            cost: 100f64,
        },
        Expense {
            item: "Food",
            cost: 300f64,
        },
        Expense {
            item: "Gym",
            cost: 50f64,
        },
    ];

    // Create a new workbook.
    let mut workbook = Workbook::new();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        let mut row = 0u32;
        for Expense { item, cost } in expenses.iter() {
            worksheet.write_string(index(row, 0)?, item, None)?;
            worksheet.write_number(index(row, 1)?, *cost, None)?;
            row += 1;
        }

        worksheet.write_string(index(row, 0)?, "Total", None)?;
        worksheet.write_formula(index(row, 1)?, "=SUM(B1:B4)", None)?;
    }

    workbook.write_file("tutorial01.xlsx")?;

    Ok(())
}

examples/doc_custom_properties.rs (line 20)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

examples/doc_properties.rs (line 23)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    // This method returns an &mut DocProperties.
    let p = workbook.properties();
    p.title = "This is an example spreadsheet".to_string();
    p.subject = "With document properties".to_string();
    p.author = "Max Mustermann".to_string();
    p.manager = "Dr. Heinz Doofenshmirtz".to_string();
    p.company = "of Wolves".to_string();
    p.category = "Example spreadsheets".to_string();
    p.keywords = "Sample, Example, Properties".to_string();
    p.comments = "Created with karo".to_string();
    p.status = "Quo".to_string();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_properties.xlsx")?;

    Ok(())
}

Additional examples can be found in:

• examples/format_font.rs
• examples/tutorial2.rs
• examples/anatomy.rs
• examples/tutorial3.rs
• examples/format_num_format.rs
• examples/data_validate.rs

pub fn add_chartsheet<S: AsRef<str>>( &mut self, sheetname: S, ) -> Result<Chartsheet>

pub fn add_format(&mut self) -> Result<Format>

pub fn add_chart(&mut self, chart_type: ChartType) -> Result<Chart>

pub fn properties(&mut self) -> &mut DocProperties

Examples found in repository

examples/doc_properties.rs (line 10)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    // This method returns an &mut DocProperties.
    let p = workbook.properties();
    p.title = "This is an example spreadsheet".to_string();
    p.subject = "With document properties".to_string();
    p.author = "Max Mustermann".to_string();
    p.manager = "Dr. Heinz Doofenshmirtz".to_string();
    p.company = "of Wolves".to_string();
    p.category = "Example spreadsheets".to_string();
    p.keywords = "Sample, Example, Properties".to_string();
    p.comments = "Created with karo".to_string();
    p.status = "Quo".to_string();

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_properties.xlsx")?;

    Ok(())
}

pub fn set_custom_property_str(&mut self, name: &str, value: &str) -> Result<()>

Examples found in repository

examples/doc_custom_properties.rs (line 11)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

pub fn set_custom_property_integer( &mut self, name: &str, value: i32, ) -> Result<()>

Examples found in repository

examples/doc_custom_properties.rs (line 13)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

pub fn set_custom_property_number( &mut self, name: &str, value: f64, ) -> Result<()>

Examples found in repository

examples/doc_custom_properties.rs (line 14)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

pub fn set_custom_property_boolean( &mut self, name: &str, value: bool, ) -> Result<()>

Examples found in repository

examples/doc_custom_properties.rs (line 15)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

pub fn set_custom_property_datetime( &mut self, name: &str, value: DateTime<Utc>, ) -> Result<()>

Examples found in repository

examples/doc_custom_properties.rs (line 12)

fn main() -> karo::Result<()> {
    // Create a new workbook.
    let mut workbook = Workbook::new();

    let datetime = Utc.ymd(2016, 12, 12).and_hms(0, 0, 0);
    workbook.set_custom_property_str("Checked by", "Eve")?;
    workbook.set_custom_property_datetime("Date completed", datetime)?;
    workbook.set_custom_property_integer("Document number", 12345)?;
    workbook.set_custom_property_number("Reference number", 1.2345)?;
    workbook.set_custom_property_boolean("Has review", true)?;
    workbook.set_custom_property_boolean("Signed off", false)?;

    {
        // Add a worksheet with a user defined name.
        let worksheet = workbook.add_worksheet(None)?;

        // Widen the first column to make the text clearer.
        worksheet.set_column(col_range(0, 0)?, 50f64, None)?;

        worksheet.write_string(
            index(0, 0)?,
            "Select 'Workbook Properties' to see properties.",
            None,
        )?;
    }

    workbook.write_file("doc_custom_properties.xlsx")?;

    Ok(())
}

pub fn get_worksheet_by_name<N: AsRef<str>>( &mut self, name: N, ) -> Option<&mut Worksheet>

pub fn get_chartsheet_by_name<N: AsRef<str>>( &mut self, name: N, ) -> Option<&mut Chartsheet>

pub fn validate_sheet_name<N: AsRef<str>>(&self, name: N) -> Result<()>

pub fn add_vba_project<P: AsRef<Path>>(&mut self, filename: P) -> Result<()>

pub fn set_vba_name<N: AsRef<str>>(&mut self, name: N) -> Result<()>

Trait Implementations

impl Default for Workbook

fn default() -> Workbook

Returns the “default value” for a type.