ooodev.format.inner.direct.write.frame.hyperlink.link_to module

class ooodev.format.inner.direct.write.frame.hyperlink.link_to.LinkTo(*, name=None, url=None, target=TargetKind.NONE)

Bases: StyleBase

Link to.

New in version 0.9.0.

__init__(*, name=None, url=None, target=TargetKind.NONE)

Constructor

Parameters:

• name (str, optional) – Link name.

• url (str, optional) – Link URL.

• target (TargetKind, str, optional) – Link target. Defaults to TargetKind.NONE.

Return type:

None

apply(obj: Any)

apply(obj: Any, **kwargs)

apply(obj, **kwargs)

Applies padding to obj

Parameters:

• obj (Any) – UNO object that supports com.sun.star.style.CharacterProperties service.

• kwargs (Any, optional) – Expandable list of key value pairs that may be used in child classes.

Return type:

None

classmethod from_obj(obj)

classmethod from_obj(obj, **kwargs)

classmethod from_obj(obj, **kwargs)

Gets hyperlink instance from object

Parameters:

obj (Any) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

LinkTo that represents obj Hyperlink.

Return type:

LinkTo

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_name: str | None

Gets/Sets name

Return type:

str | None

property prop_target: str

Gets/Sets target

Return type:

str

property prop_url: str | None

Gets/Sets url

Return type:

str | None

class ooodev.format.inner.direct.write.frame.hyperlink.link_to.TargetKind(value)

Bases: Enum

Hyperlink Target

New in version 0.9.0.

BLANK = '_blank'

Blank target

NONE = ''

No target

PARENT = '_parent'

Parent target

SELF = '_self'

Self target

TOP = '_top'

Top target