Worksheet

Overview

Worksheet is a struct in Aspose.Cells FOSS for Rust. Inherits from: Debug, Clone, PartialEq.

Encapsulates a single worksheet and its supported v0.1 worksheet features.

This struct provides 93 methods for working with Worksheet objects in Rust programs. Available methods include: auto_filter, cells, charts, clear_column_width, clear_row_height, column_properties, columns, comments, conditional_formattings, freeze_pane, freeze_panes, get_auto_filter, and 81 additional methods. All public members are accessible to any Rust application after installing the Aspose.Cells FOSS for Rust package.

Methods

Signature	Description
`name()` → `&str`	Gets the worksheet name.
`get_name()` → `&str`	Gets the worksheet name.
`set_name(name: impl Into<String>)` → `Result<(), CellsError>`	Sets the worksheet name.
`set_name_or_cells_exception(name: impl Into<String>)` → `Result<(), CellsException>`	Sets the associated value.
`visibility_type()` → `VisibilityType`	Gets the worksheet visibility state.
`get_visibility_type()` → `VisibilityType`	Gets the worksheet visibility state.
`set_visibility_type(value: VisibilityType)`	Sets the worksheet visibility state.
`tab_color()` → `Color`	Gets the worksheet tab color.
`get_tab_color()` → `Color`	Gets the worksheet tab color.
`set_tab_color(value: Color)`	Sets the worksheet tab color.
`show_gridlines()` → `bool`	Gets whether gridlines are shown in the worksheet view.
`get_show_gridlines()` → `bool`	Gets whether gridlines are shown in the worksheet view.
`set_show_gridlines(value: bool)`	Sets whether gridlines are shown in the worksheet view.
`show_row_column_headers()` → `bool`	Gets whether row and column headers are shown in the worksheet view.
`get_show_row_column_headers()` → `bool`	Gets whether row and column headers are shown in the worksheet view.
`set_show_row_column_headers(value: bool)`	Sets whether row and column headers are shown in the worksheet view.
`show_zeros()` → `bool`	Gets whether zero values are shown in the worksheet view.
`get_show_zeros()` → `bool`	Gets whether zero values are shown in the worksheet view.
`set_show_zeros(value: bool)`	Sets whether zero values are shown in the worksheet view.
`right_to_left()` → `bool`	Gets whether the worksheet view is right-to-left.
`get_right_to_left()` → `bool`	Gets whether the worksheet view is right-to-left.
`set_right_to_left(value: bool)`	Sets whether the worksheet view is right-to-left.
`zoom()` → `i32`	Gets the worksheet zoom percentage.
`get_zoom()` → `i32`	Gets the worksheet zoom percentage.
`set_zoom(value: i32)` → `Result<(), CellsError>`	Sets the worksheet zoom percentage.
`set_zoom_or_cells_exception(value: i32)` → `Result<(), CellsException>`	Sets the associated value.
`set_cell_value(row: u32, column: u32, value: CellValue)`	Sets the associated value.
`get_cell_value(row: u32, column: u32)` → `Option<&CellValue>`	Gets the associated value.
`set_cell_string(row: u32, column: u32, value: impl Into<String>)`	Sets the associated value.
`set_cell_datetime(row: u32, column: u32, value: DateTime<Utc>)`	Sets the associated value.
`set_cell_formula(row: u32, column: u32, value: impl Into<String>)`	Sets the associated value.
`set_cell_formula_with_cached_value(row: u32, column: u32, formula: impl Into<String>, cached_value: CellValue)`	Sets the associated value.
`get_formula_cached_value(row: u32, column: u32)` → `Option<&CellValue>`	Gets the associated value.
`set_cell_style(row: u32, column: u32, style: CellStyle)`	Sets the associated value.
`get_cell_style(row: u32, column: u32)` → `Option<&CellStyle>`	Gets the associated value.
`set_cell_border(row: u32, column: u32, border: Border)`	Sets the associated value.
`get_cell_border(row: u32, column: u32)` → `Option<&Border>`	Gets the associated value.
`cells()` → `Cells<'_>`	Gets the cell grid facade for the worksheet.
`get_cells()` → `Cells<'_>`	Gets the cell grid facade for the worksheet.
`get_cells_mut()` → `CellsMut<'_>`	Gets the associated value.
`page_setup()` → `&PageSetup`	Gets page setup settings for the worksheet.
`get_page_setup()` → `&PageSetup`	Gets page setup settings for the worksheet.
`get_page_setup_mut()` → `&mut PageSetup`	Gets the associated value.
`auto_filter()` → `AutoFilter<'_>`	Gets auto-filter settings for the worksheet.
`get_auto_filter()` → `AutoFilter<'_>`	Gets auto-filter settings for the worksheet.
`hyperlinks()` → `HyperlinkCollection<'_>`	Gets the worksheet hyperlink collection.
`get_hyperlinks()` → `HyperlinkCollection<'_>`	Gets the worksheet hyperlink collection.
`comments()` → `CommentCollection<'_>`	Gets the collection of comments (legacy notes) on this worksheet.
`get_comments()` → `CommentCollection<'_>`	Gets the collection of comments (legacy notes) on this worksheet.
`pictures()` → `PictureCollection<'_>`	Gets the collection of pictures on this worksheet.
`get_pictures()` → `PictureCollection<'_>`	Gets the collection of pictures on this worksheet.
`shapes()` → `ShapeCollection<'_>`	Gets the collection of drawing objects (shapes) on this worksheet.
`get_shapes()` → `ShapeCollection<'_>`	Gets the collection of drawing objects (shapes) on this worksheet.
`charts()` → `ChartCollection<'_>`	Gets the collection of charts on this worksheet.
`get_charts()` → `ChartCollection<'_>`	Gets the collection of charts on this worksheet.
`list_objects()` → `ListObjectCollection<'_>`	Gets the collection of Excel tables on this worksheet.
`get_list_objects()` → `ListObjectCollection<'_>`	Gets the collection of Excel tables on this worksheet.
`sparkline_groups()` → `SparklineGroupCollection<'_>`	Gets the associated value.
`get_sparkline_groups()` → `SparklineGroupCollection<'_>`	Gets the associated value.
`validations()` → `ValidationCollection<'_>`	Gets the worksheet data validation collection.
`get_validations()` → `ValidationCollection<'_>`	Gets the worksheet data validation collection.
`conditional_formattings()` → `ConditionalFormattingCollection<'_>`	Gets the worksheet conditional formatting collection.
`get_conditional_formattings()` → `ConditionalFormattingCollection<'_>`	Gets the worksheet conditional formatting collection.
`rows()` → `Rows<'_>`	Gets the associated value.
`get_rows()` → `Rows<'_>`	Gets the associated value.
`get_rows_mut()` → `RowsMut<'_>`	Gets the associated value.
`columns()` → `Columns<'_>`	Gets the associated value.
`get_columns()` → `Columns<'_>`	Gets the associated value.
`get_columns_mut()` → `ColumnsMut<'_>`	Gets the associated value.
`freeze_panes(row_split: u32, column_split: u32)`	Gets the current freeze-pane settings, if any.
`unfreeze_panes()`	Removes any frozen panes from the worksheet view.
`freeze_pane()` → `Option<FreezePane>`	Gets the associated value.
`get_freeze_pane()` → `Option<FreezePane>`	Gets the associated value.
`has_freeze_panes()` → `bool`	Returns whether freeze panes.
`protect()`	Marks the worksheet as protected using the current protection settings.
`unprotect()`	Clears worksheet protection and resets supported protection flags.
`protection()` → `WorksheetProtection`	Gets worksheet protection settings.
`get_protection()` → `WorksheetProtection`	Gets worksheet protection settings.
`protection_mut()` → `&mut WorksheetProtection`	Gets the associated value.
`get_protection_mut()` → `&mut WorksheetProtection`	Gets the associated value.
`is_protected()` → `bool`	Returns whether protected.
`set_column_width(column: u32, width: f64)` → `Result<(), CellsError>`	Sets the associated value.
`clear_column_width(column: u32)`	Clears column width.
`set_column_hidden(column: u32, hidden: bool)`	Sets the associated value.
`hide_column(column: u32)`	Hides the specified column.
`show_column(column: u32)`	Shows the specified column.
`column_properties(column: u32)` → `Option<ColumnProperties>`	Gets stored column properties for the specified column, if present.
`set_row_height(row: u32, height: f64)` → `Result<(), CellsError>`	Sets the associated value.
`clear_row_height(row: u32)`	Clears row height.
`set_row_hidden(row: u32, hidden: bool)`	Sets the associated value.
`hide_row(row: u32)`	Hides the specified row.
`show_row(row: u32)`	Shows the specified row.
`row_properties(row: u32)` → `Option<RowProperties>`	Gets stored row properties for the specified row, if present.

Worksheet

Overview

Methods

See Also