ooodev.format.inner.direct.write.frame.wrap.options module

class ooodev.format.inner.direct.write.frame.wrap.options.Options(*, first=None, background=None, contour=None, outside=None, overlap=None)[source]

Bases: StyleBase

Frame Vertical Alignment

New in version 0.9.0.

__init__(*, first=None, background=None, contour=None, outside=None, overlap=None)[source]

Constructor

Parameters:

  • first (bool , optional) – Specifies first paragraph.

  • background (bool , optional) – Specifies in background.

  • contour (bool , optional) – Specifies contour.

  • outside (bool , optional) – Specifies contour outside only. contour must be True for this parameter to be effective.

  • overlap (bool , optional) – Specifies allow overlap.

Return type:

None

classmethod from_obj(obj)[source]
classmethod from_obj(obj, **kwargs)
classmethod from_obj(obj, **kwargs)

Gets instance from object

Parameters:

obj (Any) – UNO Object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

Instance that represents Frame Wrap Settings.

Return type:

Options

property background: _TOptions

Gets copy of instance with in background set to True

Return type:

TypeVar(_TOptions, bound= Options)

property contour: _TOptions

Gets copy of instance with contour set to True

Return type:

TypeVar(_TOptions, bound= Options)

property first: _TOptions

Gets copy of instance with first paragraph set to True

Return type:

TypeVar(_TOptions, bound= Options)

property outside: _TOptions

Gets copy of instance with contour outside only set to True

Return type:

TypeVar(_TOptions, bound= Options)

property overlap: _TOptions

Gets copy of instance with allow overlap set to True

Return type:

TypeVar(_TOptions, bound= Options)

property prop_background: bool | None

Gets/Sets background value

Return type:

bool | None

property prop_contour: bool | None

Gets/Sets contour value

Return type:

bool | None

property prop_first: bool | None

Gets/Sets first paragraph value

Return type:

bool | None

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_outside: bool | None

Gets/Sets contour outside only value

Return type:

bool | None

property prop_overlap: bool | None

Gets/Sets allow overlap value

Return type:

bool | None