Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfFormFieldData

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
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

Accepted by parameters 1

Constructors

public RtfFormFieldData() #

Methods

public RtfFormFieldDataControl AddControl(string name, int? parameter = null, bool hasParameter = true) #

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
public void AddDropDownItem(string item) #

Adds a drop-down list item.

Parameters

item string required

Properties

public IReadOnlyList<RtfFormFieldDataControl> Controls { get; } #

Raw controls in source or creation order.

public IReadOnlyList<string> DropDownItems { get; } #

Drop-down list items from repeated \ffl destinations.

public int? TypeCode { get; set; } #

Raw \fftype value.

public RtfFormFieldKind? Kind { get; set; } #

Known form-field kind when RtfFormFieldData.TypeCode is recognized.

public string? Name { get; set; } #

Form field bookmark/name from \ffname.

public string? DefaultText { get; set; } #

Default text from \ffdeftext.

public string? Format { get; set; } #

Text formatting string from \ffformat.

public string? HelpText { get; set; } #

Custom help text from \ffhelptext.

public string? StatusText { get; set; } #

Custom status-bar text from \ffstattext.

public string? EntryMacro { get; set; } #

Entry macro name from \ffentrymcr.

public string? ExitMacro { get; set; } #

Exit macro name from \ffexitmcr.

public bool? Enabled { get; set; } #

Whether the field is enabled, from \ffenabled.

public bool? OwnHelp { get; set; } #

Whether custom help text is used, from \ffownhelp.

public bool? OwnStatus { get; set; } #

Whether custom status text is used, from \ffownstat.

public bool? Protected { get; set; } #

Whether the field is protected, from \ffprot.

public bool? RecalculateOnExit { get; set; } #

Whether field recalculation is requested, from \ffrecalc.

public int? MaxLength { get; set; } #

Maximum text length from \ffmaxlen.

public int? CheckBoxSizeHalfPoints { get; set; } #

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

public int? DefaultResult { get; set; } #

Default numeric result from \ffdefres.

public int? Result { get; set; } #

Selected numeric result from \ffres.