ooodev.format.inner.direct.structs.cell_protection_struct module

Module for Image Crop (GraphicCrop) struct

New in version 0.9.0.

class ooodev.format.inner.direct.structs.cell_protection_struct.CellProtectionStruct(hide_all=False, protected=False, hide_formula=False, hide_print=False)[source]

Bases: StructBase

Cell Protection struct.

Any properties starting with prop_ set or get current instance values.

__init__(hide_all=False, protected=False, hide_formula=False, hide_print=False)[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.

Return type:

None

apply(obj: Any)[source]

apply(obj, **kwargs)

Applies tab properties to obj

Parameters:: obj (object) – UNO object.
Return type:: None

classmethod from_obj(obj)[source]

classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:: obj (object) – UNO object
Raises:: PropertyNotFoundError – If obj does not have required property
Returns:: CellProtectionStruct instance that represents obj CellProtection properties.
Return type:: CellProtectionStruct

classmethod from_uno_struct(value)[source]

classmethod from_uno_struct(value, **kwargs)

Converts a CellProtection instance to a CellProtectionStruct.

Parameters:: value (CellProtection) – UNO CellProtection.
Returns:: CellProtectionStruct set with CellProtection properties.
Return type:: CellProtectionStruct

get_uno_struct()[source]

Gets UNO CellProtection from instance.

Returns:: CellProtection instance
Return type:: Size

property hide_all: _TCellProtectionStruct

Gets instance with hide all value set.

Return type:: TypeVar(_TCellProtectionStruct, bound= CellProtectionStruct)

property hide_formula: _TCellProtectionStruct

Gets instance with hide formula value set.

Return type:: TypeVar(_TCellProtectionStruct, bound= CellProtectionStruct)

property hide_print: _TCellProtectionStruct

Gets instance with hide print value set.

Return type:: TypeVar(_TCellProtectionStruct, bound= CellProtectionStruct)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:: FormatKind

property prop_hide_all: bool

Gets/Sets Hide all value

Return type:: bool

property prop_hide_formula: bool

Gets/Sets Hide Formula value

Return type:: bool

property prop_hide_print: bool

Gets/Sets Hide Print value

Return type:: bool

property prop_protected: bool

Gets/Sets protected value

Return type:: bool

property protected: _TCellProtectionStruct

Gets instance with protected value set.

Return type:: TypeVar(_TCellProtectionStruct, bound= CellProtectionStruct)