Class ModelHyperlinkFixed

Bases: ModelPropPartial, UnoControlFixedHyperlinkModelPartial, ModelDialogElementPartial

Constructor

Parameters:
  • component (UnoControlModel) – UNO Component that implements com.sun.star.awt.UnoControlModel service.

  • model (com.sun.star.awt.UnoControlModel) –

Return type:

None

Adds an event listener to the component.

Parameters:

listener (XEventListener) – The event listener to be added.

Return type:

None

Adds a listener for property changes.

Parameters:
  • name (str) – The name of the property.

  • listener (Any) – The listener to be added.

Return type:

None

Adds a listener for vetoable changes.

Parameters:
  • name (str) – The name of the property.

  • listener (Any) – The listener to be added.

Return type:

None

Creates a clone of the object.

Returns:

The clone.

Return type:

XCloneable

Disposes the component.

Return type:

None

Returns the property set info.

Returns:

The property set info.

Return type:

XPropertySetInfo

Returns the value of a property.

Parameters:

name (str) – The name of the property.

Returns:

The value of the property.

Return type:

Any

Removes an event listener from the component.

Parameters:

listener (XEventListener) – The event listener to be removed.

Return type:

None

Removes a listener for property changes.

Parameters:
  • name (str) – The name of the property.

  • listener (Any) – The listener to be removed.

Return type:

None

Removes a listener for vetoable changes.

Parameters:
  • name (str) – The name of the property.

  • listener (Any) – The listener to be removed.

Return type:

None

Sets the font descriptor of the control.

Parameters:

font_descriptor (FontDescriptor, FontDescriptorStructComp) – UNO Struct - Font descriptor to set.

Return type:

None

Note

The font_descriptor property can also be used to set the font descriptor.

Hint

  • FontDescriptor can be imported from ooo.dyn.awt.font_descriptor.

Return type:

None

Parameters:

font_descriptor (FontDescriptor | FontDescriptorStructComp) –

Sets the value of a property.

Parameters:
  • name (str) – The name of the property.

  • value (Any) – The value of the property.

Return type:

None

Get/Sets the horizontal alignment of the text in the control.

Hint

  • AlignKind can be imported from ooodev.utils.kind.align_kind.

Return type:

AlignKind

Gets/Set the background color of the control.

Returns:

Color

Return type:

Color

Gets/Sets the border style of the control.

Note

Value can be set with BorderKind or int.

Hint

  • BorderKind can be imported from ooodev.utils.kind.border_kind.

Return type:

BorderKind

Gets/Sets the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the border_color setting.

optional

Returns:

Color or None if not set.

Return type:

Color | None

Get or set the context_writing_mode property.

Return type:

int

Get or set the enable_visible property.

Return type:

bool

Gets/Sets whether the control is enabled or disabled.

Return type:

bool

Gets/Sets the Font Descriptor.

Setting value can be done with a FontDescriptor or FontDescriptorStructComp object.

Returns:

Font Descriptor

Return type:

FontDescriptorStructComp

Hint

  • FontDescriptor can be imported from ooo.dyn.awt.font_descriptor.

Gets/Sets the FontEmphasis value of the text in the control.

Note

Value can be set with FontEmphasisEnum or int.

Hint

  • FontEmphasisEnum can be imported from ooo.dyn.text.font_emphasis.

Return type:

FontEmphasisEnum

Gets/Sets FontRelief value of the text in the control.

Note

Value can be set with FontReliefEnum or int.

Hint

  • FontReliefEnum can be imported from ooo.dyn.text.font_relief.

Return type:

FontReliefEnum

Get/Sets the help text of the control.

Return type:

str

Gets/Sets the help URL of the control.

Return type:

str

Gets/Sets the label of the control.

Return type:

str

Uno Control Model

Return type:

UnoControlModel

Gets/Sets that the text may be displayed on more than one line.

Return type:

bool

Gets/Sets the picture for the control

When setting the value it can be a string or a Path object. If a string is passed it can be a URL or a path to a file. Value such as file:///path/to/image.png and /path/to/image.png are valid. Relative paths are supported.

Returns:

The picture URL in the format of file:///path/to/image.png or empty string if no picture is set.

Return type:

str

Gets/Sets that the control will be printed with the document.

Return type:

bool

Gets/Sets the text color of the control.

Returns:

Color

Return type:

Color

Gets/Sets the text line color (RGB) of the control.

Returns:

Color

Return type:

Color

Gets/Sets the URL.

Return type:

str

Gets/Sets the vertical alignment of the text in the control.

optional

Hint

  • VerticalAlignment can be imported from ooo.dyn.style.vertical_alignment

Return type:

VerticalAlignment | None