Paper Office
paper-xlsxAPI referenceworkbook.protection

WorkbookProtection

paper-xlsx 0.2.1 API reference

WorkbookProtection(workbookPassword=None, workbookPasswordCharacterSet=None, revisionsPassword=None, revisionsPasswordCharacterSet=None, lockStructure=None, lockWindows=None, lockRevision=None, revisionsAlgorithmName=None, revisionsHashValue=None, revisionsSaltValue=None, revisionsSpinCount=None, workbookAlgorithmName=None, workbookHashValue=None, workbookSaltValue=None, workbookSpinCount=None)

Attributes

idx_base

attributeidx_base
= 0

lockRevision

attributelockRevision
= lockRevision

lockStructure

attributelockStructure
= lockStructure

lockWindows

attributelockWindows
= lockWindows

lock_revision

attributelock_revision
= Alias('lockRevision')

lock_structure

attributelock_structure
= Alias('lockStructure')

lock_windows

attributelock_windows
= Alias('lockWindows')

namespace

attributenamespace
= None

revision_password

attributerevision_password
= Alias('revisionsPassword')

revisionsAlgorithmName

attributerevisionsAlgorithmName
= revisionsAlgorithmName

revisionsHashValue

attributerevisionsHashValue
= revisionsHashValue

revisionsPassword

attributerevisionsPassword

Return the revisions password value, regardless of hash.

revisionsPasswordCharacterSet

attributerevisionsPasswordCharacterSet
= revisionsPasswordCharacterSet

revisionsSaltValue

attributerevisionsSaltValue
= revisionsSaltValue

revisionsSpinCount

attributerevisionsSpinCount
= revisionsSpinCount

tagname

attributetagname
= 'workbookPr'

workbookAlgorithmName

attributeworkbookAlgorithmName
= workbookAlgorithmName

workbookHashValue

attributeworkbookHashValue
= workbookHashValue

workbookPassword

attributeworkbookPassword

Return the workbook password value, regardless of hash.

workbookPasswordCharacterSet

attributeworkbookPasswordCharacterSet
= workbookPasswordCharacterSet

workbookSaltValue

attributeworkbookSaltValue
= workbookSaltValue

workbookSpinCount

attributeworkbookSpinCount
= workbookSpinCount

workbook_password

attributeworkbook_password
= Alias('workbookPassword')

Functions

__iter__

func__iter__()

from_tree

funcfrom_tree(node)

Don't hash passwords when deserialising from XML

paramnode

set_revisions_password

funcset_revisions_password(value='', already_hashed=False)

Set a revision password on this workbook.

paramvalue
= ''
paramalready_hashed
= False

set_workbook_password

funcset_workbook_password(value='', already_hashed=False)

Set a password on this workbook.

paramvalue
= ''
paramalready_hashed
= False

to_tree

functo_tree(tagname=None, idx=None, namespace=None)
paramtagname
= None
paramidx
= None
paramnamespace
= None

On this page