CheckErrors Class

Mail Merge Error Reporting Setting.When the object is serialized out as xml, its qualified name is w:checkErrors.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.DecimalNumberType
        DocumentFormat.OpenXml.Wordprocessing.CheckErrors

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class CheckErrors _
    Inherits DecimalNumberType
'Usage
Dim instance As CheckErrors
public class CheckErrors : DecimalNumberType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.14.4 checkErrors (Mail Merge Error Reporting Setting)

This element specifies the type of error reporting which shall be conducted by an application when performing a mail merge against the specified source data.

The type of error reporting implied by this element shall be defined as follows:

  • Simulate the population of fields with mapped external data and report errors in a new document if the val attribute is equal to 1.

  • While populating fields with mapped external data, pausing to report each error as it occurs if the val attribute is equal to 2.

  • Populate fields with mapped external data and report errors in a new document if the val attribute is equal to 3.

  • Application-defined behaviors can be used if the val attribute is equal to any other value.

If this element is omitted, or its value is set to a value outside of those specified below that is not understood by the hosting application, then its value shall be assumed to be 2.

[Example: Consider a mail merge whose WordprocessingML definition includes the following:

<w:checkErrors w:val="3" />

The presence of a checkErrors element with a val attribute of 3 indicates that the hosting application must conduct the type of error reporting specified above, performing the mail merge, populating fields with mapped external data and reporting errors in a new document . end example]

Parent Elements

mailMerge (§17.14.20)

Attributes

Description

val (Decimal Number Value)

Specifies that the contents of this attribute contains a decimal number.

The contents of this decimal number are interpreted based on the context of the parent XML element.

[Example: Consider the following numeric WordprocessingML property of simple type ST_DecimalNumber:

<… w:val="1512645511" />

The value of the val attribute is a decimal number whose value must be interpreted in the context of the parent element. end example]

The possible values for this attribute are defined by the ST_DecimalNumber simple type (§17.18.10).

[Note: The W3C XML Schema definition of this element’s content model (CT_DecimalNumber) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

CheckErrors Members

DocumentFormat.OpenXml.Wordprocessing Namespace