Class SheetCellCustomProperties

class ooodev.calc.cell.sheet_cell_custom_properties.SheetCellCustomProperties(sheet)[source]
Parameters:

sheet (CalcSheet) –

__init__(sheet)[source]

Constructor

Parameters:
  • values (Dict[str, Any] | None, optional) – Dictionary Values. Defaults to None.

  • sheet (CalcSheet) –

get_cell_properties(*filter)[source]

Get Custom Property Cells

The keys are sorted in the cell order of across and then down. The values are the custom property names.

Parameters:

filter (Tuple[str], optional) – Custom Property Names to filter by. If omitted all custom properties are returned. Otherwise only the cell with custom properties in the list are returned.

Returns:

Cell and Custom Property Names

Return type:

Dict[mCellObj.CellObj, Set[str]]

remove_all_custom_properties()[source]

Remove all custom properties from all cells.

Warning

This is a destructive operation. It will remove all custom properties from all cells for the entire sheet.

Only use this if you are sure you want to remove all custom properties and you know what you are doing. It is possible other extensions or macros may rely on custom properties.

Return type:

None