API Reference
WordFieldInfo
Describes a field discovered in a Word document without mutating the document.
Inheritance
- Object
- WordFieldInfo
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 WordDocument.InspectFields
Inherited Methods
Properties
public Int32 Index { get; set; } #Gets the deterministic index of the field in document scan order.
public WordFieldRepresentation Representation { get; } #Gets how the field is represented in the Open XML document.
public WordFieldLocationKind LocationKind { get; } #Gets the owning document part category.
public String PartUri { get; } #Gets the package part URI that contains the field.
public String InstructionText { get; } #Gets the original field instruction text.
public String ResultText { get; } #Gets the current result text stored with the field.
public Nullable<WordFieldType> FieldType { get; } #Gets the parsed field type when the instruction is recognized.
public IReadOnlyList<String> Instructions { get; } #Gets positional instruction tokens parsed from the field instruction text.
public IReadOnlyList<String> Switches { get; } #Gets field switches parsed from the field instruction text.
public IReadOnlyList<WordFieldFormat> FormatSwitches { get; } #Gets format switches parsed from the field instruction text.
public Boolean IsDirty { get; } #Gets whether the field is marked dirty.
public Boolean IsLocked { get; } #Gets whether the field is locked.
public Int32 NestingLevel { get; } #Gets the complex/simple field nesting level at the field start.
public Boolean IsInTable { get; } #Gets whether the field is inside a table.
public Boolean IsInContentControl { get; } #Gets whether the field is inside a content control.
public Boolean IsInTextBox { get; } #Gets whether the field is inside a text box.
public IReadOnlyList<String> UnsupportedParseDetails { get; } #Gets parse diagnostics for unsupported or malformed field instructions.
public Boolean IsParsed { get; } #Gets whether the field instruction was parsed without diagnostics.