ooodev.format.calc.modify.cell.cell_protection package

Module contents

class ooodev.format.calc.modify.cell.cell_protection.CellProtection(*, hide_all=False, protected=False, hide_formula=False, hide_print=False, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Cell Style Background Color.

Note

Cell protection is only effective after the sheet is has been applied to is also been protected.

See also

New in version 0.9.0.

__init__(*, hide_all=False, protected=False, hide_formula=False, hide_print=False, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Constructor

Parameters:

  • hide_all (bool, optional) – Specifies if all is hidden. Defaults to False.

  • protected (bool, optional) – Specifies protected value. Defaults to False.

  • hide_formula (bool, optional) – Specifies if the formula is hidden. Defaults to False.

  • hide_print (bool, optional) – Specifies if the cell are to be omitted during print. Defaults to False.

  • style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

  • style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.

  • style_family (str, optional) – Style family. Default CellStyles.

Returns:

CellProtection instance from style properties.

Return type:

CellProtection

property prop_inner: InnerCellProtection

Gets/Sets Inner Cell Protection instance

Return type:

InnerCellProtection

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str