Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OdtHyperlink

Namespace OfficeIMO.OpenDocument
Assembly OfficeIMO.OpenDocument
Source revision a039964de4cc with working tree changes
Modifiers sealed

An XML-backed ODT hyperlink. Targets are preserved and never fetched.

Inheritance

  • Object
  • OdtHyperlink

Usage

Explore 6 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Methods

public OdtSpan AddSpan(String? text = null) #
Returns: OdtSpan

Appends a styled span inside this hyperlink.

Parameters

text System.String? = null optionalposition: 0
public OdtHyperlink AddText(String text) #
Returns: OdtHyperlink

Appends display text after existing child nodes.

Parameters

text System.String requiredposition: 0
public OdtHyperlink TransformTextCase(OfficeTextCase textCase, CultureInfo? culture = null) #
Returns: OdtHyperlink

Changes the hyperlink display text casing while preserving its target and text style.

Parameters

textCase OfficeIMO.Drawing.OfficeTextCase requiredposition: 0
culture System.Globalization.CultureInfo? = null optionalposition: 1

Properties

public String Text { get; set; } #

Decoded display text.

public IReadOnlyList<OdtInlineNode> InlineNodes { get; } #

Ordered text and spans inside this hyperlink.

public String Href { get; set; } #

Link target.

public String? StyleName { get; set; } #

Referenced text style name.

public Boolean? Bold { get; set; } #

Explicit or inherited bold state.

public Boolean? Italic { get; set; } #

Explicit or inherited italic state.

public Boolean? Underline { get; set; } #

Explicit or inherited underline state.

public OdfTextDecorationStyle? UnderlineStyle { get; set; } #

Explicit or inherited native underline style.

public OdfTextDecorationType? UnderlineType { get; set; } #

Explicit or inherited native underline line count.

public Boolean UsesNonSolidUnderlineStyle { get; } #

Whether the effective underline uses a non-solid ODF decoration style.

public Boolean? StrikeThrough { get; set; } #

Explicit or inherited strike-through state.

public OdfTextDecorationStyle? LineThroughStyle { get; set; } #

Explicit or inherited native line-through style.

public OdfTextDecorationType? LineThroughType { get; set; } #

Explicit or inherited native line-through line count.

public Boolean UsesNonSolidLineThroughStyle { get; } #

Whether the effective line-through uses a non-solid ODF decoration style.

public OdfLength? FontSize { get; set; } #

Explicit or inherited font size.

public OdfTextPosition? TextPosition { get; set; } #

Explicit or inherited baseline placement.

public OdfTextTransform? TextTransform { get; set; } #

Explicit or inherited display-time case transformation.

public Boolean? SmallCaps { get; set; } #

Explicit or inherited small-cap display formatting.

public String? FontFamily { get; set; } #

Explicit or inherited font family.

public OdfColor? Color { get; set; } #

Explicit or inherited text color.

public OdfColor? BackgroundColor { get; set; } #

Explicit or inherited text background color.

public Boolean HasTextBackgroundOverride { get; } #

Whether an inline style sets a text background, including transparent.