paper-xlsxAPI referenceworksheet.protection

SheetProtection

paper-xlsx 0.2.1 API reference

Information about protection of various aspects of a sheet. True values mean that protection for the object or action is active This is the default when protection is active, ie. users cannot do something

SheetProtection(sheet=False, objects=False, scenarios=False, formatCells=True, formatRows=True, formatColumns=True, insertColumns=True, insertRows=True, insertHyperlinks=True, deleteColumns=True, deleteRows=True, selectLockedCells=False, selectUnlockedCells=False, sort=True, autoFilter=True, pivotTables=True, password=None, algorithmName=None, saltValue=None, spinCount=None, hashValue=None)

Attributes

`algorithmName`

attributealgorithmName

= algorithmName

`autoFilter`

attributeautoFilter

= autoFilter

`deleteColumns`

attributedeleteColumns

= deleteColumns

`deleteRows`

attributedeleteRows

= deleteRows

`enabled`

attributeenabled

= Alias('sheet')

`formatCells`

attributeformatCells

= formatCells

`formatColumns`

attributeformatColumns

= formatColumns

`formatRows`

attributeformatRows

= formatRows

`hashValue`

attributehashValue

= hashValue

`idx_base`

attributeidx_base

= 0

`insertColumns`

attributeinsertColumns

= insertColumns

`insertHyperlinks`

attributeinsertHyperlinks

= insertHyperlinks

`insertRows`

attributeinsertRows

= insertRows

`namespace`

attributenamespace

= None

`objects`

attributeobjects

= objects

`password`

attributepassword

= password

`pivotTables`

attributepivotTables

= pivotTables

`saltValue`

attributesaltValue

= saltValue

`scenarios`

attributescenarios

= scenarios

`selectLockedCells`

attributeselectLockedCells

= selectLockedCells

`selectUnlockedCells`

attributeselectUnlockedCells

= selectUnlockedCells

`sheet`

attributesheet

= sheet

`sort`

attributesort

= sort

`spinCount`

attributespinCount

= spinCount

`tagname`

attributetagname

= 'sheetProtection'

Functions

`iter`

func__iter__()

`disable`

funcdisable()

`enable`

funcenable()

`from_tree`

funcfrom_tree(node)

Create object from XML

paramnode

`set_password`

funcset_password(value='', already_hashed=False)

paramvalue

= ''

paramalready_hashed

= False

`to_tree`

functo_tree(tagname=None, idx=None, namespace=None)

paramtagname

= None

paramidx

= None

paramnamespace

= None

openpyxl.worksheet.protection

paper-xlsx 0.2.1 API reference

openpyxl.worksheet.related

paper-xlsx 0.2.1 API reference