API Reference

Class

WordFieldUpdateResult

Namespace OfficeIMO.Word
Assembly OfficeIMO.Word
Modifiers sealed

Describes a single field update outcome.

Inheritance

  • Object
  • WordFieldUpdateResult

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

Properties

public Int32 Index { get; } #

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 Nullable<WordFieldType> FieldType { get; } #

Gets the parsed field type when available.

public WordFieldUpdateStatus Status { get; } #

Gets the outcome of the update attempt.

public String ResultText { get; } #

Gets the result text written to the field, when one was written.

public String Message { get; } #

Gets a short diagnostic message for the outcome.