Function col_range

pub fn col_range<C>(first: C, last: C) -> Result<ColRange>
where
    Col: TryFrom<C, Error = Error>,

Examples found in repository

examples/doc_custom_properties.rs (line 23)

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

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(())
}

examples/format_font.rs (line 28)

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

    // Add some cell formats.
    let mut myformat1 = Format::default();
    let mut myformat2 = Format::default();
    let mut myformat3 = Format::default();

    // Set the bold property for format 1.
    myformat1.font.bold = true;

    // Set the italic property for format 2.
    myformat2.font.italic = true;

    // Set the bold and italic properties for format 3.
    myformat3.font.bold = true;
    myformat3.font.italic = true;

    {
        let worksheet = workbook.add_worksheet(None)?;

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

        worksheet.write_string(
            index(0, 0)?,
            "This is bold",
            Some(&myformat1),
        )?;
        worksheet.write_string(
            index(1, 0)?,
            "This is italic",
            Some(&myformat2),
        )?;
        worksheet.write_string(
            index(2, 0)?,
            "Bold and italic",
            Some(&myformat3),
        )?;
    }

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

    Ok(())
}

examples/anatomy.rs (line 24)

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

    // Add some cell formats.
    let mut myformat1 = Format::default();
    let mut myformat2 = Format::default();

    // Set the bold property for the first format.
    myformat1.font.bold = true;

    // Set a number format for the second format.
    myformat2.num_format = NumFormat::Custom("$#,##0.00".to_string());

    {
        // Add a worksheet with a user defined name.
        let worksheet1 = workbook.add_worksheet(Some("Demo"))?;

        // Widen the first column to make the text clearer.
        worksheet1.set_column(col_range(0, 0)?, 20.0, None)?;

        // Write some unformatted data.
        worksheet1.write_string(index(0, 0)?, "Peach", None)?;
        worksheet1.write_string(index(1, 0)?, "Plum", None)?;

        // Write formatted data.
        worksheet1.write_string(index(2, 0)?, "Pear", Some(&myformat1))?;

        // Formats can be reused.
        worksheet1.write_string(
            index(3, 0)?,
            "Persimmon",
            Some(&myformat1),
        )?;

        // Write some numbers.
        worksheet1.write_number(index(5, 0)?, 123.0, None)?;
        worksheet1.write_number(
            index(6, 0)?,
            4567.555,
            Some(&myformat2),
        )?;
    }

    {
        let worksheet2 = workbook.add_worksheet(None)?;

        worksheet2.write_string(
            index(0, 0)?,
            "Some text",
            Some(&myformat1),
        )?;
    }

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

    Ok(())
}

examples/format_num_format.rs (line 14)

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

    {
        let worksheet = workbook.add_worksheet(None)?;

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

        let mut f = Format::default();

        // 3.1415926
        worksheet.write_number(index(0, 0)?, 3.1415926, None)?;

        // 3.142
        f.num_format = NumFormat::from_format_string("0.000");
        worksheet.write_number(index(1, 0)?, 3.1415926, Some(&f))?;

        // 1,235
        f.num_format = NumFormat::from_format_string("#,##0");
        worksheet.write_number(index(2, 0)?, 1234.56, Some(&f))?;

        // 1,234.56
        f.num_format = NumFormat::from_format_string("#,##0.00");
        worksheet.write_number(index(3, 0)?, 1234.56, Some(&f))?;

        // 49.99
        f.num_format = NumFormat::from_format_string("0.00");
        worksheet.write_number(index(4, 0)?, 49.99, Some(&f))?;

        // 01/01/01
        f.num_format = NumFormat::from_format_string("mm/dd/yy");
        worksheet.write_number(index(5, 0)?, 36892.521, Some(&f))?;

        // Jan 1 2001
        f.num_format = NumFormat::from_format_string("mmm d yyyy");
        worksheet.write_number(index(6, 0)?, 36892.521, Some(&f))?;

        // 1 January 2001
        f.num_format = NumFormat::from_format_string("d mmmm yyyy");
        worksheet.write_number(index(7, 0)?, 36892.521, Some(&f))?;

        // 01/01/2001 12:30 AM
        f.num_format =
            NumFormat::from_format_string("dd/mm/yyyy hh:mm AM/PM");
        worksheet.write_number(index(8, 0)?, 36892.521, Some(&f))?;

        // 1 dollar and .87 cents
        f.num_format = NumFormat::from_format_string(
            "0 \"dollar and\" .00 \"cents\"",
        );
        worksheet.write_number(index(9, 0)?, 1.87, Some(&f))?;

        // Show limited conditional number formats.
        f.num_format = NumFormat::from_format_string(
            "[Green]General;[Red]-General;General",
        );
        worksheet.write_number(index(10, 0)?, 123.0, Some(&f))?; // > 0 Green
        worksheet.write_number(index(11, 0)?, -45.0, Some(&f))?; // < 0 Red
        worksheet.write_number(index(12, 0)?, 0.0, Some(&f))?; // = 0 Default color

        // Format a Zip code
        f.num_format = NumFormat::from_format_string("00000");
        worksheet.write_number(index(13, 0)?, 1209.0, Some(&f))?;
    }

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

    Ok(())
}

examples/data_validate.rs (line 60)

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

    let mut format = Format::default();
    format.borders.set_around(Some(Border {
        style: BorderStyle::Thin,
        color: None,
    }));
    format.fill.fg_color = Some(RGB8 {
        r: 0xc6,
        g: 0xef,
        b: 0xce,
    });
    format.fill.pattern = Some(Pattern::Solid);
    format.font.bold = true;
    format.text_wrap = true;
    format.vertical_alignment = Some(VerticalAlignment::Center);
    format.indent = 1;

    {
        let worksheet = workbook.add_worksheet(None)?;
        write_data(worksheet, Some(&format))?;

        // Set up layout of the worksheet.
        worksheet.set_column(col_range(0, 0)?, 55f64, None)?;
        worksheet.set_column(col_range(1, 1)?, 15f64, None)?;
        worksheet.set_column(col_range(3, 3)?, 15f64, None)?;
        worksheet.set_row(row_range(0, 0)?, 36f64, None)?;

        // Example 1. Limiting input to an integer in a fixed range.
        worksheet.write_string(
            cell("A3")?,
            "Enter an integer between 1 and 10",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::Integer(Criterion::Between(1, 10)),
            cell("B3")?,
        );
        worksheet.data_validation(validation)?;

        // Example 2. Limiting input to an integer outside a fixed range.
        worksheet.write_string(
            cell("A5")?,
            "Enter an integer not between 1 and 10 \
             (using cell references)",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::IntegerFormula(Criterion::NotBetween(
                "=E3".to_string(),
                "=F3".to_string(),
            )),
            cell("B5")?,
        );
        worksheet.data_validation(validation)?;

        // Example 3. Limiting input to an integer greater than a fixed value.
        worksheet.write_string(
            cell("A7")?,
            "Enter an integer greater than 0",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::Integer(Criterion::GreaterThan(0)),
            cell("B7")?,
        );
        worksheet.data_validation(validation)?;

        // Example 4. Limiting input to an integer less than a fixed value.
        worksheet.write_string(
            cell("A9")?,
            "Enter an integer less than 10",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::Integer(Criterion::LessThan(10)),
            cell("B9")?,
        );
        worksheet.data_validation(validation)?;

        // Example 5. Limiting input to a decimal in a fixed range.
        worksheet.write_string(
            cell("A11")?,
            "Enter a decimal between 0.1 and 0.5",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::Decimal(Criterion::Between(0.1, 0.5)),
            cell("B11")?,
        );
        worksheet.data_validation(validation)?;

        // Example 6. Limiting input to a value in dropdown list.
        worksheet.write_string(
            cell("A13")?,
            "Select a value from a drop down list",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::List {
                values: indexset! {
                    "open".to_string(),
                    "high".to_string(),
                    "close".to_string(),
                },
                show_dropdown: true,
            },
            cell("B13")?,
        );
        worksheet.data_validation(validation)?;

        // Example 7. Limiting input to a value in a dropdown list.
        worksheet.write_string(
            cell("A15")?,
            "Select a value from a drop down list (using a cell range)",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::ListFormula {
                formula: "=$E$4:$G$4".to_string(),
                show_dropdown: true,
            },
            cell("B15")?,
        );
        worksheet.data_validation(validation)?;

        // Example 8. Limiting input to date in a fixed range.
        worksheet.write_string(
            cell("A17")?,
            "Enter a date between 1/1/2008 and 12/12/2008",
            None,
        )?;
        let date1 = Utc.ymd(2008, 1, 1).and_hms(0, 0, 0);
        let date2 = Utc.ymd(2008, 12, 12).and_hms(0, 0, 0);
        let validation = Validation::new(
            ValidationType::Date(Criterion::Between(date1, date2)),
            cell("B17")?,
        );
        worksheet.data_validation(validation)?;

        // Example 9. Limiting input to time in a fixed range.
        worksheet.write_string(
            cell("A19")?,
            "Enter a time between 6:00 and 12:00",
            None,
        )?;
        let time1 = NaiveTime::from_hms(6, 0, 0);
        let time2 = NaiveTime::from_hms(12, 0, 0);
        let validation = Validation::new(
            ValidationType::Time(Criterion::Between(time1, time2)),
            cell("B19")?,
        );
        worksheet.data_validation(validation)?;

        // Example 10. Limiting input to a string greater than a fixed length.
        worksheet.write_string(
            cell("A21")?,
            "Enter a string longer than 3 characters",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::Length(Criterion::GreaterThan(3)),
            cell("B21")?,
        );
        worksheet.data_validation(validation)?;

        // Example 11. Limiting input based on a formula.
        worksheet.write_string(
            cell("A23")?,
            "Enter a value if the folowing is true \"=AND(F5=50,G5=60)\"",
            None,
        )?;
        let validation = Validation::new(
            ValidationType::CustomFormula("=AND(F5=50,G5=60)".to_string()),
            cell("B23")?,
        );
        worksheet.data_validation(validation)?;

        // Example 12. Displaying and modifying data validation messages.
        worksheet.write_string(
            cell("A25")?,
            "Displays a message when you select the cell",
            None,
        )?;
        let mut validation = Validation::new(
            ValidationType::Integer(Criterion::Between(1, 100)),
            cell("B25")?,
        );
        validation.input_title = Some("Enter an integer:".to_string());
        validation.input_message = Some("between 1 and 100".to_string());
        worksheet.data_validation(validation)?;

        // Example 13. Displaying and modifying data validation messages.
        worksheet.write_string(
            cell("A27")?,
            "Displays a custom error message when integer isn't \
             between 1 and 100",
            None,
        )?;
        let mut validation = Validation::new(
            ValidationType::Integer(Criterion::Between(1, 100)),
            cell("B27")?,
        );
        validation.input_title = Some("Enter an integer:".to_string());
        validation.input_message = Some("between 1 and 100".to_string());
        validation.error_title =
            Some("Input value is not valid!".to_string());
        validation.error_message = Some(
            "It should be an integer \
             between 1 and 100"
                .to_string(),
        );
        worksheet.data_validation(validation)?;

        // Example 14. Displaying and modifying data validation messages.
        worksheet.write_string(
            cell("A29")?,
            "Displays a custom info message when integer isn't \
             between 1 and 100",
            None,
        )?;
        let mut validation = Validation::new(
            ValidationType::Integer(Criterion::Between(1, 100)),
            cell("B29")?,
        );
        validation.input_title = Some("Enter an integer:".to_string());
        validation.input_message = Some("between 1 and 100".to_string());
        validation.error_title =
            Some("Input value is not valid!".to_string());
        validation.error_message = Some(
            "It should be an integer \
             between 1 and 100"
                .to_string(),
        );
        validation.error_type = ValidationErrorType::Information;
        worksheet.data_validation(validation)?;
    }

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

    Ok(())
}