ooodev.format.writer.direct.char.hyperlink package

Module contents

class ooodev.format.writer.direct.char.hyperlink.Hyperlink(*, name=None, url=None, target=TargetKind.NONE, visited_style='Visited Internet Link', unvisited_style='Internet link')

Bases: LinkTo

New in version 0.9.0.

__init__(*, name=None, url=None, target=TargetKind.NONE, visited_style='Visited Internet Link', unvisited_style='Internet link')

Constructor

Parameters:

• name (str, optional) – Link name.

• url (str, optional) – Link URL.

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

• visited_style (str, optional) – Link visited style. Defaults to Internet link.

• unvisited_style (str, optional) – Link unvisited style. Defaults to Visited Internet Link.

Return type:

None

See also

• Write Direct Character Hyperlink Class

classmethod from_obj(obj)

classmethod from_obj(obj, **kwargs)

classmethod from_obj(obj, **kwargs)

Gets hyperlink instance from object

Parameters:

obj (object) – UNO object.

Raises:

NotSupportedError – If obj is not supported.

Returns:

Hyperlink that represents obj Hyperlink.

Return type:

Hyperlink

property empty: _THyperlink

Gets Highlight empty.

Return type:

TypeVar(_THyperlink, bound= Hyperlink)

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_unvisited_style: str

Gets/Sets style for links that have not yet been visited

Return type:

str

property prop_visited_style: str

Gets/Sets visited style

Return type:

str