Share via


ProofError Class

Defines the ProofError Class.When the object is serialized out as xml, its qualified name is w:proofErr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.ProofError

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

Syntax

'Declaration
Public Class ProofError _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As ProofError
public class ProofError : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.13.5.1 proofErr (Proofing Error Anchor)

This element specifies the presence of a start or end anchor for a single proofing error within a WordprocessingML document.

When proofing errors are stored in a document, their semantics shall be interpreted as follows:

  • Each proofing error with a type attribute value of spellStart shall be linked with the next error with a type attribute of spellEnd. If one does not exist, then this error should be ignored.

  • Each proofing error with a type attribute value of spellEnd which was not preceded by an error with a type attribute value of spellStart (that was not previously matched to an end) should be ignored.

  • Each proofing error with a type attribute value of gramStart shall be linked with the next error with a type attribute of gramEnd. If one does not exist, then this error should be ignored.

  • Each proofing error with a type attribute value of gramEnd which was not preceded by an error with a type attribute value of gramStart (that was not previously matched to an end) should be ignored.

[Example: Consider the following sentence with a grammatical error in its subject/verb agreement. If an application recognized this error and wished to persist it to the document, this paragraph would consist of the following WordprocessingML markup:

<w:p>
<w:proofErr w:type="gramStart"/>
<w:r>
<w:t>This are</w:t>
</w:r>
<w:proofErr w:type="gramEnd"/>
<w:r>
<w:t xml:space="preserve"> an error.</w:t>
</w:r>
</w:p>

The proofErr elements, with a val attribute value of gramStart and gramEnd respectively, delimit the start and end the content in this paragraph which is stored as a grammatical error. end example]

Parent Elements

bdo (§17.3.2.3); body (§17.2.2); comment (§17.13.4.2); customXml (§17.5.1.6); customXml (§17.5.1.4); customXml (§17.5.1.5); customXml (§17.5.1.3); deg (§22.1.2.26); del (§17.13.5.14); den (§22.1.2.28); dir (§17.3.2.8); docPartBody (§17.12.6); e (§22.1.2.32); endnote (§17.11.2); fldSimple (§17.16.19); fName (§22.1.2.37); footnote (§17.11.10); ftr (§17.10.3); hdr (§17.10.4); hyperlink (§17.16.22); ins (§17.13.5.18); lim (§22.1.2.52); moveFrom (§17.13.5.22); moveTo (§17.13.5.25); num (§22.1.2.75); oMath (§22.1.2.77); p (§17.3.1.22); rt (§17.3.3.24); rubyBase (§17.3.3.27); sdtContent (§17.5.2.34); sdtContent (§17.5.2.33); sdtContent (§17.5.2.35); sdtContent (§17.5.2.36); smartTag (§17.5.1.9); sub (§22.1.2.112); sup (§22.1.2.114); tbl (§17.4.38); tc (§17.4.66); tr (§17.4.79)

Attributes

Description

type (Proofing Error Anchor Type)

Specifies the type of proofing error anchor at this location in the document. This proofing error type implies the necessary semantics for this element as defined by the parent element.

[Example: Consider the following sentence with a proofing error, consisting of the following WordprocessingML markup:

<w:r>
<w:t>are</w:t>
</w:r>
<w:proofErr w:val="gramEnd"/>
<w:r>
<w:t xml:space="preserve"> an error.</w:t>
</w:r>

The val attribute value of gramEnd specifies that the proofing error is the location of the end of content which is stored as a grammatical error. end example]

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

[Note: The W3C XML Schema definition of this element’s content model (CT_ProofErr) 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

ProofError Members

DocumentFormat.OpenXml.Wordprocessing Namespace