# RtfFormFieldData

Word form-field metadata stored in an RTF \ffdata destination.

Class 

`OfficeIMO.Rtf`

**Namespace**

`OfficeIMO.Rtf`

**Assembly**

`OfficeIMO.Rtf`

**Source revision**

`ba882f6b0d07` with working tree changes

**Source**

[RtfFormFieldData.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L7)

**Implements**

`IRtfCloneable`

**Modifiers**

sealed

Word form-field metadata stored in an RTF \ffdata destination.

## Inheritance

- object
- RtfFormFieldData

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

- Method [RtfField.GetOrCreateFormFieldData](/api/rtf/officeimo-rtf-rtffield/#method-getorcreateformfielddata)
- Property [RtfField.FormFieldData](/api/rtf/officeimo-rtf-rtffield/#property-formfielddata)

### Accepted by parameters 1

- Method [RtfField.SetFormFieldData](/api/rtf/officeimo-rtf-rtffield/#method-setformfielddata-action-officeimo-rtf-rtfformfielddata) parameter `configure`

Filter members 

Show inherited

## Constructors

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

[RtfFormFieldData.cs:7](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L7)

## Methods

`public RtfFormFieldDataControl AddControl(string name, int? parameter = null, bool hasParameter = true)` [#](#method-addcontrol-string-nullable-system-int32-boolean)

[RtfFormFieldData.cs:78](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L78)

Adds a raw \ffdata control in write order and updates known convenience properties.

Parameters

**name string required**

**parameter int? = null optional**

**hasParameter bool = true optional**

Returns

`RtfFormFieldDataControl`

`public void AddDropDownItem(string item)` [#](#method-adddropdownitem-string)

[RtfFormFieldData.cs:86](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L86)

Adds a drop-down list item.

Parameters

**item string required**

## 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 IReadOnlyList<RtfFormFieldDataControl> Controls { get; }` [#](#property-controls)

[RtfFormFieldData.cs:11](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L11)

Raw controls in source or creation order.

`public IReadOnlyList<string> DropDownItems { get; }` [#](#property-dropdownitems)

[RtfFormFieldData.cs:14](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L14)

Drop-down list items from repeated \ffl destinations.

`public int? TypeCode { get; set; }` [#](#property-typecode)

[RtfFormFieldData.cs:17](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L17)

Raw \fftype value.

`public RtfFormFieldKind? Kind { get; set; }` [#](#property-kind)

[RtfFormFieldData.cs:22](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L22)

Known form-field kind when [RtfFormFieldData.TypeCode](/api/rtf/officeimo-rtf-rtfformfielddata/) is recognized.

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

[RtfFormFieldData.cs:29](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L29)

Form field bookmark/name from \ffname.

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

[RtfFormFieldData.cs:32](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L32)

Default text from \ffdeftext.

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

[RtfFormFieldData.cs:35](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L35)

Text formatting string from \ffformat.

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

[RtfFormFieldData.cs:38](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L38)

Custom help text from \ffhelptext.

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

[RtfFormFieldData.cs:41](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L41)

Custom status-bar text from \ffstattext.

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

[RtfFormFieldData.cs:44](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L44)

Entry macro name from \ffentrymcr.

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

[RtfFormFieldData.cs:47](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L47)

Exit macro name from \ffexitmcr.

`public bool? Enabled { get; set; }` [#](#property-enabled)

[RtfFormFieldData.cs:50](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L50)

Whether the field is enabled, from \ffenabled.

`public bool? OwnHelp { get; set; }` [#](#property-ownhelp)

[RtfFormFieldData.cs:53](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L53)

Whether custom help text is used, from \ffownhelp.

`public bool? OwnStatus { get; set; }` [#](#property-ownstatus)

[RtfFormFieldData.cs:56](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L56)

Whether custom status text is used, from \ffownstat.

`public bool? Protected { get; set; }` [#](#property-protected)

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

Whether the field is protected, from \ffprot.

`public bool? RecalculateOnExit { get; set; }` [#](#property-recalculateonexit)

[RtfFormFieldData.cs:62](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L62)

Whether field recalculation is requested, from \ffrecalc.

`public int? MaxLength { get; set; }` [#](#property-maxlength)

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

Maximum text length from \ffmaxlen.

`public int? CheckBoxSizeHalfPoints { get; set; }` [#](#property-checkboxsizehalfpoints)

[RtfFormFieldData.cs:68](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L68)

Check-box size in half-points from \ffhps.

`public int? DefaultResult { get; set; }` [#](#property-defaultresult)

[RtfFormFieldData.cs:71](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L71)

Default numeric result from \ffdefres.

`public int? Result { get; set; }` [#](#property-result)

[RtfFormFieldData.cs:74](https://github.com/EvotecIT/OfficeIMO/blob/ba882f6b0d07acddd884b5e7d3086b0cfff0a05a/OfficeIMO.Rtf/Model/RtfFormFieldData.cs#L74)

Selected numeric result from \ffres.

<!-- PowerForge markdown artifact sha256:0676088CF6E685CA0EB239E0C7FCE9E5D54523A365B51A7E6FB7CA0B7625A230 -->
