Class DocxFormReport

Namespace

DocToolkit

Assembly

DocToolkit.Docx.dll

The content controls a document carries, and what is currently in them.

public sealed class DocxFormReport

Inheritance

object

DocxFormReport

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Fields

The content controls this document exposes under the DocxFormKey asked for.

public IReadOnlyList<DocxFormField> Fields { get; }

Property Value

IReadOnlyList<DocxFormField>

Remarks

Not necessarily every control in the document, for three measured reasons. A control is absent when it has no name under that key mode; only the first of several controls sharing a name appears; and a control in a header or a footer is never included, because only the body is read. Measured: two controls sharing a tag yield one field, a tag-only template read with Alias yields none at all — which looks exactly like a document that has no form — and a header control is missing while DocxMailMerge would have found it.

The order is not document order. Measured: a form authored FullName, Plan, Start, Signed comes back Signed, Start, Plan, FullName. Nothing here promises any order, so sort by Key if you are rendering a form and the sequence matters.

Validate(byte[], IReadOnlyDictionary<string, DocxFormValue>, DocxFormKey) reports both cases, as DuplicateKey and UnmappedControl.