ooodev.adapter.util.cell_protection_struct_comp module

class ooodev.adapter.util.cell_protection_struct_comp.CellProtectionStructComp(component, prop_name, event_provider=None)[source]

Bases: ComponentBase

Cell Protection Struct

This class raises an event before and after a property is changed if it has been passed an event provider.

The event raised before the property is changed is called com_sun_star_util_CellProtection_changing. The event raised after the property is changed is called com_sun_star_util_CellProtection_changed.

The event args for before the property is changed is of type KeyValCancelArgs. The event args for after the property is changed is of type KeyValArgs.

Parameters:

component (CellProtection) –
prop_name (str) –
event_provider (EventsT | None) –

__init__(component, prop_name, event_provider=None)[source]

Constructor

Parameters:

component (CellProtection) – Font Descriptor.
prop_name (str) – Property Name. This value is assigned to the prop_name of event_data.
event_provider (EventsT, optional) – Event Provider.

Return type:

None

copy()[source]

Makes a copy of the Border Line.

Returns:: Copied Border Line.
Return type:: CellProtection

property component: CellProtection

CellProtection Component

Return type:: CellProtection

property is_formula_hidden: bool

Gets/Sets if the formula is hidden from the user.

Return type:: bool

property is_hidden: bool

Gets/Sets if the cell is hidden from the user.

Return type:: bool

property is_locked: bool

Gets/Sets if the cell is locked from modifications by the user.

Return type:: bool

property is_print_hidden: bool

Gets/Sets if the cell is hidden on printouts.

Return type:: bool