Skip to main content

Module sheet

Module sheet 

Source
Expand description

Sheet management utilities.

Contains validation helpers and internal functions used by crate::workbook::Workbook for creating, deleting, renaming, and copying worksheets.

Structs§

SheetProtectionConfig
Configuration for sheet protection.
SheetViewOptions
Options controlling the display of a sheet view.

Enums§

SheetVisibility
Sheet visibility state.
ViewMode
View mode for a sheet.

Functions§

active_sheet_index
Get the active sheet index (0-based) from bookViews, defaulting to 0.
add_sheet
Add a new sheet. Returns the 0-based index of the new sheet.
copy_sheet
Copy a sheet, returning the 0-based index of the new copy.
delete_sheet
Delete a sheet by name.
find_sheet_index
Find the index (0-based) of a sheet by name.
get_default_col_width
Get the default column width for a sheet.
get_default_row_height
Get the default row height for a sheet.
get_panes
Get the current freeze pane cell reference, if any.
get_sheet_view_options
Read the current sheet view options from a worksheet.
get_tab_color
Get the tab color of a sheet as an RGB hex string.
is_sheet_protected
Check if a sheet is protected.
next_rid
Generate the next available rId for workbook relationships.
next_sheet_id
Generate the next available sheet ID.
protect_sheet
Protect a sheet with optional password and permission settings.
rename_sheet
Rename a sheet.
set_active_sheet_index
Set the active sheet by index in bookViews.
set_default_col_width
Set the default column width for a sheet.
set_default_row_height
Set the default row height for a sheet.
set_panes
Set freeze panes on a worksheet.
set_sheet_view_options
Set sheet view options on a worksheet.
set_tab_color
Set the tab color of a sheet using an RGB hex string (e.g. “FF0000” for red).
unprotect_sheet
Remove sheet protection.
unset_panes
Remove any freeze or split panes from a worksheet.
validate_sheet_name
Validate a sheet name according to Excel rules.