API Reference
RtfFormFieldData
Word form-field metadata stored in an RTF \ffdata destination.
Inheritance
- Object
- RtfFormFieldData
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method RtfField.GetOrCreateFormFieldData
- Property RtfField.FormFieldData
Accepted by parameters
- Method RtfField.SetFormFieldData
Constructors
public RtfFormFieldData() #Methods
public RtfFormFieldDataControl AddControl(String name, Nullable<Int32> parameter = null, Boolean hasParameter = true) #RtfFormFieldDataControlAdds a raw \ffdata control in write order and updates known convenience properties.
Parameters
- name System.String
- parameter System.Nullable{System.Int32} = null
- hasParameter System.Boolean = true
public Void AddDropDownItem(String item) #VoidAdds a drop-down list item.
Parameters
- item System.String
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
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 Nullable<Int32> TypeCode { get; set; } #Raw \fftype value.
public Nullable<RtfFormFieldKind> Kind { get; set; } #Known form-field kind when 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 Nullable<Boolean> Enabled { get; set; } #Whether the field is enabled, from \ffenabled.
public Nullable<Boolean> OwnHelp { get; set; } #Whether custom help text is used, from \ffownhelp.
public Nullable<Boolean> OwnStatus { get; set; } #Whether custom status text is used, from \ffownstat.
public Nullable<Boolean> Protected { get; set; } #Whether the field is protected, from \ffprot.
public Nullable<Boolean> RecalculateOnExit { get; set; } #Whether field recalculation is requested, from \ffrecalc.
public Nullable<Int32> MaxLength { get; set; } #Maximum text length from \ffmaxlen.
public Nullable<Int32> CheckBoxSizeHalfPoints { get; set; } #Check-box size in half-points from \ffhps.
public Nullable<Int32> DefaultResult { get; set; } #Default numeric result from \ffdefres.
public Nullable<Int32> Result { get; set; } #Selected numeric result from \ffres.