Struct umya_spreadsheet::structs::Spreadsheet
source · pub struct Spreadsheet { /* private fields */ }
Expand description
A Spreadsheet Object. The starting point of all struct.
Implementations§
source§impl Spreadsheet
impl Spreadsheet
sourcepub fn insert_new_row(
&mut self,
sheet_name: &str,
row_index: &u32,
num_rows: &u32
)
pub fn insert_new_row( &mut self, sheet_name: &str, row_index: &u32, num_rows: &u32 )
sourcepub fn insert_new_column(
&mut self,
sheet_name: &str,
column: &str,
num_columns: &u32
)
pub fn insert_new_column( &mut self, sheet_name: &str, column: &str, num_columns: &u32 )
sourcepub fn insert_new_column_by_index(
&mut self,
sheet_name: &str,
column_index: &u32,
num_columns: &u32
)
pub fn insert_new_column_by_index( &mut self, sheet_name: &str, column_index: &u32, num_columns: &u32 )
sourcepub fn remove_row(&mut self, sheet_name: &str, row_index: &u32, num_rows: &u32)
pub fn remove_row(&mut self, sheet_name: &str, row_index: &u32, num_rows: &u32)
sourcepub fn remove_column(
&mut self,
sheet_name: &str,
column: &str,
num_columns: &u32
)
pub fn remove_column( &mut self, sheet_name: &str, column: &str, num_columns: &u32 )
sourcepub fn remove_column_by_index(
&mut self,
sheet_name: &str,
column_index: &u32,
num_columns: &u32
)
pub fn remove_column_by_index( &mut self, sheet_name: &str, column_index: &u32, num_columns: &u32 )
sourcepub fn get_cell_value_by_address(&self, address: &str) -> Vec<&CellValue>
pub fn get_cell_value_by_address(&self, address: &str) -> Vec<&CellValue>
sourcepub fn get_theme_mut(&mut self) -> &mut Theme
pub fn get_theme_mut(&mut self) -> &mut Theme
Get Theme in mutable.
sourcepub fn get_properties(&self) -> &Properties
pub fn get_properties(&self) -> &Properties
Get Properties.
sourcepub fn get_properties_mut(&mut self) -> &mut Properties
pub fn get_properties_mut(&mut self) -> &mut Properties
Get Properties in mutable.
sourcepub fn set_properties(&mut self, value: Properties) -> &mut Self
pub fn set_properties(&mut self, value: Properties) -> &mut Self
sourcepub fn get_macros_code(&self) -> Option<&Vec<u8>>
pub fn get_macros_code(&self) -> Option<&Vec<u8>>
sourcepub fn set_macros_code(&mut self, value: Vec<u8>) -> &mut Self
pub fn set_macros_code(&mut self, value: Vec<u8>) -> &mut Self
sourcepub fn remove_macros_code(&mut self) -> &mut Self
pub fn remove_macros_code(&mut self) -> &mut Self
Remove Macros Code
sourcepub fn get_has_macros(&self) -> bool
pub fn get_has_macros(&self) -> bool
Has Macros Code
sourcepub fn set_code_name<S: ToString>(&mut self, codename: S) -> &mut Self
pub fn set_code_name<S: ToString>(&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).
sourcepub fn get_code_name(&self) -> Option<&str>
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
sourcepub fn get_sheet_collection(&self) -> &Vec<Worksheet>
pub fn get_sheet_collection(&self) -> &Vec<Worksheet>
Get Work Sheet List.
sourcepub fn get_sheet_collection_no_check(&self) -> &Vec<Worksheet>
pub fn get_sheet_collection_no_check(&self) -> &Vec<Worksheet>
Get Work Sheet List. No check deserialized.
sourcepub fn get_sheet_collection_mut(&mut self) -> &mut Vec<Worksheet>
pub fn get_sheet_collection_mut(&mut self) -> &mut Vec<Worksheet>
Get Work Sheet List in mutable.
sourcepub fn get_sheet_count(&self) -> usize
pub fn get_sheet_count(&self) -> usize
sourcepub fn read_sheet_collection(&mut self) -> &mut Self
pub fn read_sheet_collection(&mut self) -> &mut Self
deserialize by all worksheet.
sourcepub fn read_sheet(&mut self, index: usize) -> &mut Self
pub fn read_sheet(&mut self, index: usize) -> &mut Self
deserialize a worksheet.
sourcepub fn get_sheet_by_name(&self, sheet_name: &str) -> Option<&Worksheet>
pub fn get_sheet_by_name(&self, sheet_name: &str) -> Option<&Worksheet>
pub fn get_lazy_read_sheet_cells( &self, index: &usize ) -> Result<Cells, &'static str>
sourcepub fn get_sheet_mut(&mut self, index: &usize) -> Option<&mut Worksheet>
pub fn get_sheet_mut(&mut self, index: &usize) -> Option<&mut Worksheet>
sourcepub fn get_sheet_by_name_mut(
&mut self,
sheet_name: &str
) -> Option<&mut Worksheet>
pub fn get_sheet_by_name_mut( &mut self, sheet_name: &str ) -> Option<&mut Worksheet>
pub fn set_active_sheet(&mut self, index: u32) -> &mut Self
sourcepub fn get_active_sheet(&self) -> &Worksheet
pub fn get_active_sheet(&self) -> &Worksheet
sourcepub fn get_active_sheet_mut(&mut self) -> &mut Worksheet
pub fn get_active_sheet_mut(&mut self) -> &mut Worksheet
sourcepub fn new_sheet<S: Into<String>>(
&mut self,
sheet_title: S
) -> Result<&mut Worksheet, &'static str>
pub fn new_sheet<S: Into<String>>( &mut self, sheet_title: S ) -> Result<&mut Worksheet, &'static str>
sourcepub fn set_sheet_name<S: Into<String>>(
&mut self,
index: usize,
sheet_name: S
) -> Result<(), &'static str>
pub fn set_sheet_name<S: Into<String>>( &mut self, index: usize, sheet_name: S ) -> Result<(), &'static str>
sourcepub fn get_workbook_view(&self) -> &WorkbookView
pub fn get_workbook_view(&self) -> &WorkbookView
Get Workbook View.
sourcepub fn get_workbook_view_mut(&mut self) -> &mut WorkbookView
pub fn get_workbook_view_mut(&mut self) -> &mut WorkbookView
Get Workbook View in mutable.
sourcepub fn set_workbook_view(&mut self, value: WorkbookView) -> &mut Self
pub fn set_workbook_view(&mut self, value: WorkbookView) -> &mut Self
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
sourcepub fn get_defined_names(&self) -> &Vec<DefinedName>
pub fn get_defined_names(&self) -> &Vec<DefinedName>
Get Defined Name (Vec).
sourcepub fn get_defined_names_mut(&mut self) -> &mut Vec<DefinedName>
pub fn get_defined_names_mut(&mut self) -> &mut Vec<DefinedName>
Get Defined Name (Vec) in mutable.
sourcepub fn set_defined_names(&mut self, value: Vec<DefinedName>)
pub fn set_defined_names(&mut self, value: Vec<DefinedName>)
sourcepub fn add_defined_names(&mut self, value: DefinedName)
pub fn add_defined_names(&mut self, value: DefinedName)
Trait Implementations§
source§impl Clone for Spreadsheet
impl Clone for Spreadsheet
source§fn clone(&self) -> Spreadsheet
fn clone(&self) -> Spreadsheet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Spreadsheet
impl Debug for Spreadsheet
source§impl Default for Spreadsheet
impl Default for Spreadsheet
source§fn default() -> Spreadsheet
fn default() -> Spreadsheet
Auto Trait Implementations§
impl Freeze for Spreadsheet
impl RefUnwindSafe for Spreadsheet
impl Send for Spreadsheet
impl Sync for Spreadsheet
impl Unpin for Spreadsheet
impl UnwindSafe for Spreadsheet
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.