Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OdpHyperlink

OfficeIMO.OpenDocument

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

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

Inheritance

  • object
  • OdpHyperlink

Usage

Explore 5 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 OdpRun AddRun(string? text = null) #

Appends a styled run inside this hyperlink.

Parameters

text string? = null optional

Returns

OdpRun
public OdpHyperlink AddText(string text) #

Appends display text after existing child nodes.

Parameters

text string required
public OdpHyperlink TransformTextCase(OfficeTextCase textCase, CultureInfo? culture = null) #

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

Parameters

textCase OfficeIMO.Drawing.OfficeTextCase required
culture System.Globalization.CultureInfo? = null optional

Properties

public string Text { get; set; } #

Decoded display text.

public IReadOnlyList<OdpInlineNode> InlineNodes { get; } #

Ordered text and runs inside this hyperlink.

public string Href { get; set; } #

Link target.

public string? TargetFrameName { get; set; } #

ODF target frame behavior, if authored.

public string? ShowBehavior { get; set; } #

Raw XLink show behavior, if authored.

public string? StyleName { get; set; } #

Referenced text style name.

public bool? Bold { get; set; } #

Explicit or inherited bold state.

public bool? Italic { get; set; } #

Explicit or inherited italic state.

public bool? 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 bool UsesNonSolidUnderlineStyle { get; } #

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

public bool? 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 bool 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 bool? 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 bool HasTextBackgroundOverride { get; } #

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