Struct umya_spreadsheet::structs::Worksheet

pub struct Worksheet { /* private fields */ }

Implementations

impl Worksheet

pub fn get_value<S: Into<String>>(&self, coordinate: S) -> String

Get value.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• String - Value of the specified cell.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let value = worksheet.get_value("A1");

pub fn get_value_by_column_and_row(&self, col: u32, row: u32) -> String

Get value by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

• String - Value of the specified cell.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let value = worksheet.get_value_by_column_and_row(1, 1);

pub fn get_formatted_value<S: Into<String>>(&self, coordinate: S) -> String

Get formatted value.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• String - Formatted value of the specified cell.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let value = worksheet.get_formatted_value("A1");

pub fn get_formatted_value_by_column_and_row(
    &self,
    col: u32,
    row: u32
) -> String

Get formatted value by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

• String - Formatted value of the specified cell.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let value = worksheet.get_formatted_value_by_column_and_row(1, 1);

pub fn get_cell_collection(&self) -> &Vec<Cell>

pub fn get_cell_collection_mut(&mut self) -> &mut Vec<Cell>

pub fn get_cell_collection_to_hashmap(&self) -> HashMap<String, &Cell>

pub fn get_collection_by_row(&self, row_num: &u32) -> BTreeMap<u32, &Cell>

pub fn get_cell<S: Into<String>>(&self, coordinate: S) -> Option<&Cell>

Get cell.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• Option - Cell in the Some.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let cell = worksheet.get_cell("A1");

pub fn get_cell_by_column_and_row(&self, col: u32, row: u32) -> Option<&Cell>

Gets the cell by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

• Option - Cell in the Some.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let cell = worksheet.get_cell_by_column_and_row(1, 1);  // get cell from A1. 

pub fn get_cell_mut<S: Into<String>>(&mut self, coordinate: S) -> &mut Cell

Get cell with mutable.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• &mut Cell - Cell with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let cell = worksheet.get_cell_mut("A1");

pub fn get_cell_by_column_and_row_mut(
    &mut self,
    col: u32,
    row: u32
) -> &mut Cell

Gets the cell with mutable by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

*&mut Cell - Cell with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let cell = worksheet.get_cell_by_column_and_row_mut(1, 1);  // get cell from A1. 

pub fn set_cell(&mut self, cell: Cell) -> &mut Self

pub fn get_cell_value<S: Into<String>>(&self, coordinate: S) -> &CellValue

Get cell value.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• &CellValue - CellValue.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let cell_value = worksheet.get_cell_value("A1");

pub fn get_cell_value_by_column_and_row(&self, col: u32, row: u32) -> &CellValue

Gets the cell value by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

• &CellValue - CellValue.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let cell_value = worksheet.get_style_by_column_and_row(1, 1);  // get cell from A1. 

pub fn get_cell_value_mut<S: Into<String>>(
    &mut self,
    coordinate: S
) -> &mut CellValue

Get cell value with mutable.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• &mut CellValue - CellValue with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let cell_value = worksheet.get_cell_value_mut("A1");

pub fn get_cell_value_by_column_and_row_mut(
    &mut self,
    col: u32,
    row: u32
) -> &mut CellValue

Gets the cell value with mutable by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

*&mut CellValue - CellValue with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let cell_value = worksheet.get_cell_value_by_column_and_row_mut(1, 1);  // get cell_value from A1. 

pub fn get_cell_value_by_range<S: Into<String>>(
    &self,
    range: S
) -> Vec<&CellValue>

pub fn get_style<S: Into<String>>(&self, coordinate: S) -> &Style

Get style.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• &Style - Style.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let style = worksheet.get_style("A1");

pub fn get_style_by_column_and_row(&self, col: u32, row: u32) -> &Style

Gets the style by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

• &Style - Style.

Examples

let book = umya_spreadsheet::new_file();
let worksheet = book.get_sheet(0).unwrap();
let style = worksheet.get_style_by_column_and_row(1, 1);  // get cell from A1. 

pub fn get_style_mut<S: Into<String>>(&mut self, coordinate: S) -> &mut Style

Get style with mutable.

Arguments

• coordinate - Specify the coordinates. ex) “A1”

Return value

• &mut Style - Style with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let style = worksheet.get_style_mut("A1");

pub fn get_style_by_column_and_row_mut(
    &mut self,
    col: u32,
    row: u32
) -> &mut Style

Gets the style with mutable by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)

Return value

*&mut Style - Style with mutable.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let style = worksheet.get_style_by_column_and_row_mut(1, 1);  // get style from A1. 

pub fn set_style_by_column_and_row(
    &mut self,
    col: u32,
    row: u32,
    style: Style
) -> &mut Self

Set the style by specifying the column number and row number.

Arguments

• col - Specify the column number. (first column number is 1)
• row - Specify the row number. (first row number is 1)
• style - Style.

Return value

*&mut Self - self.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let mut style = umya_spreadsheet::Style::default();
style.get_borders_mut().get_bottom_mut().set_border_style(umya_spreadsheet::Border::BORDER_MEDIUM);
let style = worksheet.set_style_by_column_and_row(1, 1, style);  // set style to A1. 

pub fn set_style_by_range<S: Into<String>>(
    &mut self,
    range: S,
    style: Style
) -> &mut Self

Set style by range.

Arguments

• range - Specify the range. ex) “A1:B2”
• style - Style

Return value

• &mut Self - Self.

Examples

let mut book = umya_spreadsheet::new_file();
let mut worksheet = book.get_sheet_mut(0);
let mut style = umya_spreadsheet::Style::default();
style.get_borders_mut().get_bottom_mut().set_border_style(umya_spreadsheet::Border::BORDER_MEDIUM);
worksheet.set_style_by_range("A1:A3", style);

pub fn get_comments(&self) -> &Vec<Comment>

pub fn get_comments_mut(&mut self) -> &mut Vec<Comment>

pub fn get_comments_to_hashmap(&self) -> HashMap<String, &Comment>

pub fn set_comments(&mut self, value: Vec<Comment>)

pub fn add_comments(&mut self, value: Comment)

pub fn has_comments(&self) -> bool

pub fn get_conditional_styles_collection(&self) -> &Vec<ConditionalSet>

pub fn set_conditional_styles_collection(&mut self, value: Vec<ConditionalSet>)

pub fn get_merge_cells(&self) -> &Vec<Range>

pub fn get_merge_cells_mut(&mut self) -> &mut Vec<Range>

pub fn get_auto_filter(&self) -> &Option<AutoFilter>

pub fn get_auto_filter_mut(&mut self) -> &mut Option<AutoFilter>

pub fn set_auto_filter<S: Into<String>>(&mut self, value: S)

pub fn remove_auto_filter(&mut self)

pub fn get_column_dimensions(&self) -> &Vec<Column>

pub fn get_column_dimension(&self, col: &u32) -> Option<&Column>

pub fn get_column_dimension_mut(&mut self, col: &u32) -> Option<&mut Column>

pub fn set_column_dimensions(&mut self, value: Column)

pub fn get_row_dimensions(&self) -> &Vec<Row>

pub fn get_row_dimensions_to_b_tree_map(&self) -> BTreeMap<u32, &Row>

pub fn get_row_dimension(&self, row: &u32) -> Option<&Row>

pub fn get_row_dimension_mut(&mut self, row: &u32) -> Option<&mut Row>

pub fn get_worksheet_drawing(&self) -> &WorksheetDrawing

pub fn get_worksheet_drawing_mut(&mut self) -> &mut WorksheetDrawing

pub fn set_worksheet_drawing(&mut self, value: WorksheetDrawing)

pub fn has_drawing_object(&self) -> bool

pub fn get_code_name(&self) -> &Option<String>

pub fn get_header_footer(&self) -> &HeaderFooter

pub fn set_header_footer(&mut self, value: HeaderFooter)

pub fn get_active_cell(&self) -> &str

pub fn get_sheet_id(&self) -> &String

pub fn has_code_name(&self) -> bool

pub fn get_tab_color(&self) -> &Option<Color>

pub fn calculate_worksheet_dimension(&self) -> String

pub fn get_title(&self) -> &str

pub fn set_title<S: Into<String>>(&mut self, value: S) -> &mut Self

pub fn get_sheet_state(&self) -> &String

pub fn set_sheet_state(&mut self, value: String)

pub fn get_page_setup(&self) -> &PageSetup

pub fn set_page_setup(&mut self, value: PageSetup)

pub fn get_page_margins(&self) -> &PageMargins

pub fn set_page_margins(&mut self, value: PageMargins)

pub fn get_sheet_view(&self) -> &SheetView

pub fn get_sheet_view_mut(&mut self) -> &mut SheetView

pub fn set_sheet_view(&mut self, value: SheetView) -> &mut Self

pub fn get_ole_objects(&self) -> &OleObjects

pub fn get_ole_objects_mut(&mut self) -> &mut OleObjects

pub fn set_ole_objects(&mut self, value: OleObjects) -> &mut Self

pub fn has_ole_objects(&self) -> bool

pub fn has_legacy_drawing(&self) -> bool

pub fn get_defined_names(&self) -> &Vec<DefinedName>

pub fn get_defined_names_mut(&mut self) -> &mut Vec<DefinedName>

pub fn set_defined_names(&mut self, value: Vec<DefinedName>)

pub fn add_defined_names(&mut self, value: DefinedName)

pub fn add_defined_name<S: Into<String>>(
    &mut self,
    name: S,
    address: S
) -> Result<(), &str>

Trait Implementations

impl Clone for Worksheet

fn clone(&self) -> Worksheet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Worksheet

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

Formats the value using the given formatter.

impl Default for Worksheet

fn default() -> Worksheet

Returns the “default value” for a type.