Expand description
Sheet management utilities.
Contains validation helpers and internal functions used by crate::workbook::Workbook
for creating, deleting, renaming, and copying worksheets.
Structs§
- Sheet
Protection Config - Configuration for sheet protection.
- Sheet
View Options - Options controlling the display of a sheet view.
Enums§
- Sheet
Visibility - Sheet visibility state.
- View
Mode - 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.