API Reference
RtfField
RTF field with instruction text and rich inline result content.
Inheritance
- Object
- RtfField
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.SetFormFieldData
- Method RtfParagraph.AddEquationField
- Method RtfParagraph.AddField
Constructors
Methods
public RtfRun AddText(String text) #RtfRunAdds visible result text.
Parameters
- text System.String
public RtfFormFieldData GetOrCreateFormFieldData() #RtfFormFieldDataCreates form-field metadata if it does not already exist and returns it.
public RtfHyperlinkFieldInfo GetOrCreateHyperlinkField() #RtfHyperlinkFieldInfoCreates hyperlink field metadata if it does not already exist and returns it.
public RtfField SetFormFieldData(Action<RtfFormFieldData> configure) #RtfFieldConfigures Word form-field metadata for this field.
Parameters
- configure System.Action{OfficeIMO.Rtf.RtfFormFieldData}
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Instruction { get; set; } #Raw field instruction text, for example PAGE \* MERGEFORMAT.
public RtfFieldCodeSyntax FieldCode { get; set; } #Lossless typed syntax for Instruction.
public RtfParagraph Result { get; set; } #Visible field result content.
public RtfHyperlinkFieldInfo HyperlinkField { get; set; } #Parsed metadata for HYPERLINK fields. The raw Instruction remains authoritative.
public Boolean IsEquation { get; } #Gets whether this is a Word EQ mathematical equation field.
public Uri Hyperlink { get; set; } #Parsed hyperlink target for HYPERLINK fields.
public RtfFormFieldData FormFieldData { get; set; } #Optional Word form-field metadata from an RTF \ffdata destination.