# RtfHyperlinkFieldInfo

Parsed semantic metadata for an RTF HYPERLINK field instruction. The original RtfField.Instruction remains the authoritative field code.

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfHyperlinkFieldInfo.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L24)

**Implements**

`IRtfCloneable`

**Modifiers**

sealed

Parsed semantic metadata for an RTF HYPERLINK field instruction. The original [RtfField.Instruction](/api/rtf/officeimo-rtf-rtffield/) remains the authoritative field code.

## Inheritance

- object
- RtfHyperlinkFieldInfo

## Usage

Explore 3 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.

### Returned or exposed by 3

- Method [RtfField.GetOrCreateHyperlinkField](/api/rtf/officeimo-rtf-rtffield/#method-getorcreatehyperlinkfield)
- Property [RtfField.HyperlinkField](/api/rtf/officeimo-rtf-rtffield/#property-hyperlinkfield)
- Method [RtfHyperlinkFieldInfo.Clone](/api/rtf/officeimo-rtf-rtfhyperlinkfieldinfo/#method-clone)

Filter members 

Show inherited

## Constructors

`public RtfHyperlinkFieldInfo()` [#](#constructor-ctor)

## Methods

`public RtfHyperlinkFieldInfo Clone()` [#](#method-clone)

[RtfHyperlinkFieldInfo.cs:24](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L24)

Creates a copy of this hyperlink field metadata.

Returns

`RtfHyperlinkFieldInfo`

`public string ToInstruction()` [#](#method-toinstruction)

[RtfHyperlinkFieldInfo.cs:34](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L34)

Creates a canonical HYPERLINK field instruction with lossless quote escaping.

Returns

`string`

## Inherited Methods

`public virtual bool Equals(object? obj)` [#](#method-equals-object)

Inherited from object

Parameters

**obj object? required**

Returns

`bool`

`public virtual int GetHashCode()` [#](#method-gethashcode)

Inherited from object

Returns

`int`

`public Type GetType()` [#](#method-gettype)

Inherited from object

Returns

`Type`

`public virtual string? ToString()` [#](#method-tostring)

Inherited from object

Returns

`string?`

## Properties

`public Uri? Target { get; set; }` [#](#property-target)

[RtfHyperlinkFieldInfo.cs:9](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L9)

Target URI from the first non-switch argument.

`public string? SubAddress { get; set; }` [#](#property-subaddress)

[RtfHyperlinkFieldInfo.cs:12](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L12)

Optional bookmark or location switch from \l.

`public string? ScreenTip { get; set; }` [#](#property-screentip)

[RtfHyperlinkFieldInfo.cs:15](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L15)

Optional screen tip switch from \o.

`public string? TargetFrame { get; set; }` [#](#property-targetframe)

[RtfHyperlinkFieldInfo.cs:18](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L18)

Optional target frame switch from \t.

`public string? ImageMap { get; set; }` [#](#property-imagemap)

[RtfHyperlinkFieldInfo.cs:21](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfHyperlinkFieldInfo.cs#L21)

Optional image-map switch argument from \m.

<!-- PowerForge markdown artifact sha256:0847C96A0FB52FFC684B7F55A85EEC586D489959B0D6BEAFDA0FBC3B4FD03555 -->
