Struct Spreadsheet

pub struct Spreadsheet { /* private fields */ }

A Spreadsheet Object. The starting point of all struct.

Implementations

impl Spreadsheet

pub fn insert_new_row( &mut self, sheet_name: &str, row_index: &u32, num_rows: &u32, )

Insert new rows.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• row_index - Specify point of insert. ex) 1
• num_rows - Specify number to insert. ex) 2

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_row("Sheet1", &2, &3);

pub fn insert_new_column( &mut self, sheet_name: &str, column: &str, num_columns: &u32, )

Insert new columns.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• column - Specify point of insert. ex) “B”
• num_columns - Specify number to insert. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_column("Sheet1", "B", &3);

pub fn insert_new_column_by_index( &mut self, sheet_name: &str, column_index: &u32, num_columns: &u32, )

Insert new columns.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• column_index - Specify point of insert. ex) 2
• num_columns - Specify number to insert. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.insert_new_column_by_index("Sheet1", &2, &3);

pub fn remove_row(&mut self, sheet_name: &str, row_index: &u32, num_rows: &u32)

Remove rows.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• row_index - Specify point of remove. ex) &1
• num_rows - Specify number to remove. ex) &2

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_row("Sheet1", &2, &3);

pub fn remove_column( &mut self, sheet_name: &str, column: &str, num_columns: &u32, )

Remove columns.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• column - Specify point of remove. ex) “B”
• num_columns - Specify number to remove. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_column("Sheet1", "B", &3);

pub fn remove_column_by_index( &mut self, sheet_name: &str, column_index: &u32, num_columns: &u32, )

Remove columns.

Arguments

• sheet_name - Specify the sheet name. ex) “Sheet1”
• column_index - Specify point of remove. ex) 2
• num_columns - Specify number to remove. ex) 3

Examples

let mut book = umya_spreadsheet::new_file();
book.remove_column_by_index("Sheet1", &2, &3);

pub fn get_cell_value_by_address(&self, address: &str) -> Vec<&CellValue>

Gets the cell value by specifying an address.

Arguments

• address - address. ex) “Sheet1!A1:C5”

Return value

*Vec<&CellValue> - CellValue List.

Examples

let mut book = umya_spreadsheet::new_file();
let mut cell_value_List = book.get_cell_value_by_address("Sheet1!A1:C5");

pub fn get_theme(&self) -> &Theme

Get Theme.

pub fn get_theme_mut(&mut self) -> &mut Theme

Get Theme in mutable.

pub fn set_theme(&mut self, value: Theme) -> &mut Self

Set Theme.

Arguments

• value - Theme

pub fn get_properties(&self) -> &Properties

Get Properties.

pub fn get_properties_mut(&mut self) -> &mut Properties

Get Properties in mutable.

pub fn set_properties(&mut self, value: Properties) -> &mut Self

Set Properties.

Arguments

• value - Properties

pub fn get_macros_code(&self) -> Option<&[u8]>

Get Macros Code.

Return value

• Option<&Vec<u8>> - Macros Code Raw Data.

pub fn set_macros_code(&mut self, value: impl Into<ThinVec<u8>>) -> &mut Self

Set Macros Code.

Arguments

• value - Macros Code Raw Data.

pub fn remove_macros_code(&mut self) -> &mut Self

Remove Macros Code

pub fn get_has_macros(&self) -> bool

Has Macros Code

pub fn get_jsa_macros_code(&self) -> Option<&[u8]>

Get Macros Code.

Return value

• Option<&Vec<u8>> - Macros Code Raw Data.

pub fn set_jsa_macros_code( &mut self, value: impl Into<ThinVec<u8>>, ) -> &mut Self

Set Macros Code.

Arguments

• value - Macros Code Raw Data.

pub fn remove_jsa_macros_code(&mut self) -> &mut Self

Remove Macros Code

pub fn get_has_jsa_macros(&self) -> bool

Has Macros Code

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

Set codeName property of workbook

May be useful when importing VBA/macros code from another workbook and only used when writing book with macros code

Default one is ThisWorkbook.

Excel often uses Workbook________ (8 underscores).

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

Get codeName property of workbook

Must to be the same in workbook with VBA/macros code from this workbook for that code in Workbook object to work out of the box without adjustments

pub fn get_sheet_collection(&self) -> &[Worksheet]

Get Work Sheet List.

pub fn get_sheet_collection_no_check(&self) -> &[Worksheet]

Get Work Sheet List. No check deserialized.

pub fn get_sheet_collection_mut(&mut self) -> &mut ThinVec<Worksheet>

Get Work Sheet List in mutable.

pub fn get_sheet_count(&self) -> usize

Get Work Sheet Count.

Return value

• usize - Work Sheet Count.

pub fn read_sheet_collection(&mut self) -> &mut Self

deserialize by all worksheet.

pub fn read_sheet(&mut self, index: usize) -> &mut Self

deserialize a worksheet.

pub fn read_sheet_by_name(&mut self, sheet_name: &str) -> &mut Self

deserialize a worksheet.

pub fn get_sheet(&self, index: &usize) -> Option<&Worksheet>

Get Work Sheet.

Arguments

• index - sheet index

Return value

• Option<&Worksheet>.

pub fn get_sheet_by_name(&self, sheet_name: &str) -> Option<&Worksheet>

Get Work Sheet.

Arguments

• sheet_name - sheet name

Return value

• `Option<&Worksheet>.

pub fn get_lazy_read_sheet_cells( &self, index: &usize, ) -> Result<Cells, &'static str>

pub fn get_sheet_mut(&mut self, index: &usize) -> Option<&mut Worksheet>

Get Work Sheet in mutable.

Arguments

• index - sheet index

Return value

• Option<&mut Worksheet>.

pub fn get_sheet_by_name_mut( &mut self, sheet_name: &str, ) -> Option<&mut Worksheet>

Get Work Sheet in mutable.

Arguments

• sheet_name - sheet name

Return value

• Option<&mut Worksheet>.

pub fn set_active_sheet(&mut self, index: u32) -> &mut Self

pub fn get_active_sheet(&self) -> &Worksheet

Get Active Work Sheet.

Return value

• &Worksheet - Work sheet.

pub fn get_active_sheet_mut(&mut self) -> &mut Worksheet

Get Active Work Sheet in mutable.

Return value

• &mut Worksheet - Work sheet.

pub fn add_sheet( &mut self, value: Worksheet, ) -> Result<&mut Worksheet, &'static str>

Add Work Sheet.

Arguments

• value - Work Sheet

Return value

• Result<&mut Worksheet, &'static str> - OK:added work sheet. Err:Error.

pub fn remove_sheet(&mut self, index: usize) -> Result<(), &'static str>

Remove Work Sheet.

Arguments

• index - sheet index

Return value

• Result<(), &'static str> - OK:removed worksheet. Err:Error.

pub fn remove_sheet_by_name( &mut self, sheet_name: &str, ) -> Result<(), &'static str>

Remove Work Sheet.

Arguments

• sheet_name - sheet name

Return value

• Result<(), &'static str> - OK:removed worksheet. Err:Error.

pub fn new_sheet<S: Into<String>>( &mut self, sheet_title: S, ) -> Result<&mut Worksheet, &'static str>

Add New Work Sheet.

Arguments

• sheet_title - sheet title

Return value

• Result<&mut Worksheet, &'static str> - OK:added work sheet. Err:Error.

pub fn set_sheet_name<S: Into<String>>( &mut self, index: usize, sheet_name: S, ) -> Result<(), &'static str>

Set Sheet Name.

Arguments

• index - target sheet index
• sheet_name - sheet name

Return value

• Result<(), &'static str> - OK:Success Err:Error.

pub fn get_workbook_view(&self) -> &WorkbookView

Get Workbook View.

pub fn get_workbook_view_mut(&mut self) -> &mut WorkbookView

Get Workbook View in mutable.

pub fn set_workbook_view(&mut self, value: WorkbookView) -> &mut Self

Set Workbook View.

Arguments

• value - WorkbookView

pub fn get_workbook_protection(&self) -> Option<&WorkbookProtection>

pub fn get_workbook_protection_mut(&mut self) -> &mut WorkbookProtection

pub fn set_workbook_protection( &mut self, value: WorkbookProtection, ) -> &mut Self

pub fn remove_workbook_protection(&mut self) -> &mut Self

pub fn get_defined_names(&self) -> &[DefinedName]

Get Defined Name (Vec).

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

Get Defined Name (Vec) in mutable.

pub fn set_defined_names(&mut self, value: impl Into<ThinVec<DefinedName>>)

Set Defined Name (Vec).

Arguments

• value - Vec.

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

Add Defined Name.

Arguments

• value - DefinedName.

pub fn has_threaded_comments(&self) -> bool

Has ThreadedComments.

Trait Implementations

impl Clone for Spreadsheet

fn clone(&self) -> Spreadsheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spreadsheet

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

Formats the value using the given formatter.

impl Default for Spreadsheet

fn default() -> Spreadsheet

Returns the “default value” for a type.