Skip to content

Commit 854adde

Browse files
authored
Docs for new function: get_sheet_visible and unprotect_workbook (#1)
1 parent 6f05cc1 commit 854adde

File tree

3 files changed

+26
-1
lines changed

3 files changed

+26
-1
lines changed

en/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Excelize for Python is a Python port of Go [Excelize](https://github.com/xuri/ex
99
- PyPI: [pypi.org/project/excelize](https://pypi.org/project/excelize)
1010
- Licenses: [BSD 3-Clause](https://opensource.org/licenses/BSD-3-Clause)
1111
- Last version: [v0.0.4](https://github.com/xuri/excelize-py/releases/latest)
12-
- Document update time: July 11, 2025
12+
- Document update time: July 21, 2025
1313

1414
## Project mission
1515

en/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* [Set worksheet properties](workbook.md#SetSheetProps)
2929
* [Get worksheet properties](workbook.md#GetSheetProps)
3030
* [Set worksheet view properties](workbook.md#SetSheetView)
31+
* [Get worksheet view properties](workbook.md#GetSheetView)
3132
* [Set worksheet page layout](workbook.md#SetPageLayout)
3233
* [Set worksheet page margins](workbook.md#SetPageMargins)
3334
* [Set workbook properties](workbook.md#SetWorkbookProps)
@@ -38,6 +39,7 @@
3839
* [Get application properties](workbook.md#GetAppProps)
3940
* [Set document properties](workbook.md#SetDocProps)
4041
* [Protect workbook](workbook.md#ProtectWorkbook)
42+
* [Unprotect workbook](workbook.md#UnprotectWorkbook)
4143
* [Worksheet](sheet.md)
4244
* [Set column visibility](sheet.md#SetColVisible)
4345
* [Set column width](sheet.md#SetColWidth)

en/workbook.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,21 @@ For example, hide `Sheet1`:
198198
f.set_sheet_visible("Sheet1", False)
199199
```
200200

201+
## Get worksheet visible {#GetSheetVisible}
202+
203+
```python
204+
def get_sheet_visible(sheet: str) -> bool
205+
```
206+
207+
Get visible state of the sheet by given sheet name. For example, get the visible state of `Sheet1`:
208+
209+
```python
210+
try:
211+
visible = f.get_sheet_visible("Sheet1")
212+
except RuntimeError as err:
213+
print(err)
214+
```
215+
201216
## Set worksheet properties {#SetSheetProps}
202217

203218
```python
@@ -827,3 +842,11 @@ class WorkbookProtectionOptions:
827842
lock_structure: bool = False
828843
lock_windows: bool = False
829844
```
845+
846+
## Unprotect workbook {#UnprotectWorkbook}
847+
848+
```python
849+
def unprotect_workbook(*password: str) -> None
850+
```
851+
852+
Remove protection for workbook, specified the optional password parameter to remove workbook protection with password verification.

0 commit comments

Comments
 (0)