# RtfFieldCodeSyntax

Lossless typed syntax for an RTF field instruction.

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfFieldCodeSyntax.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L69)

**Modifiers**

sealed

Lossless typed syntax for an RTF field instruction.

## Inheritance

- object
- RtfFieldCodeSyntax

## Usage

Explore 2 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 2

- Property [RtfField.FieldCode](/api/rtf/officeimo-rtf-rtffield/#property-fieldcode)
- Method [RtfFieldCodeSyntax.Parse](/api/rtf/officeimo-rtf-rtffieldcodesyntax/#method-parse-string)

Filter members 

Show inherited

## Methods

`public static RtfFieldCodeSyntax Parse(string instruction)` [#](#method-parse-string)

[RtfFieldCodeSyntax.cs:69](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L69)

Parses a field instruction without discarding trivia or unknown switches.

Parameters

**instruction string required**

Returns

`RtfFieldCodeSyntax`

## 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 string Text { get; }` [#](#property-text)

[RtfFieldCodeSyntax.cs:59](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L59)

Gets the exact authored field instruction.

`public string? Keyword { get; }` [#](#property-keyword)

[RtfFieldCodeSyntax.cs:61](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L61)

Gets the decoded leading field keyword.

`public IReadOnlyList<RtfFieldCodeToken> Tokens { get; }` [#](#property-tokens)

[RtfFieldCodeSyntax.cs:63](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L63)

Gets every token, including whitespace, in authored order.

`public bool IsValid { get; }` [#](#property-isvalid)

[RtfFieldCodeSyntax.cs:65](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFieldCodeSyntax.cs#L65)

Gets whether every quoted argument is terminated.

<!-- PowerForge markdown artifact sha256:DD8C8E06BB525102A2A79D42787BC7DE92924610EB574BFC47B53820136D8931 -->
