ProofState Class
Spelling and Grammatical Checking State.When the object is serialized out as xml, its qualified name is w:proofState.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.ProofState
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class ProofState _
Inherits OpenXmlLeafElement
'Usage
Dim instance As ProofState
public class ProofState : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.65 proofState (Spelling and Grammatical Checking State)
This element specifies if the grammar and spell checking engines of the last application to process this document completed checking the grammar and spelling of a the document before the document was last saved. Applications which modify the document contents without checking spelling or grammar should reset these states as needed.
[Note: If this element specifies that an application's grammar and spell checking engines completed checking the grammar and spelling of the document when the document was last saved, then subsequent applications might elect to not run their grammar and spell checking engines when the given WordprocessingML document is loaded.
This might increase the speed with which the hosting application loads the file, and does not compromise the state of the grammar or spell checking of the document, as all errors have already been found and flagged with the proofErr element (§17.13.8.1) as the document has not been edited, only loaded, since it was last saved. end note]
[Example: Consider a WordprocessingML document that is saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings:
<w:proofState w:spelling="clean" w:grammar="clean" />
The proofState element's attributes spelling and grammar attribute both have the value clean specifying that the hosting application's grammar and spell checking engines completed checking both the grammar and spelling of the given document when it was last saved. end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
grammar (Grammatical Checking State) |
Specifies if an application's grammar checking engine completed checking the grammatical content of the document when it was last saved. If this attribute is omitted, then its value is assumed to be dirty (not complete). [Example: Consider a WordprocessingML document saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings: <w:proofState w:spelling="clean" w:grammar="clean" /> The grammar attribute has the value clean specifying that the hosting application's grammar checking engine completed checking the grammar of the given document when it was last saved. end example] The possible values for this attribute are defined by the ST_Proof simple type (§17.18.69). |
spelling (Spell Checking State) |
Specifies if an application's spell checking engine completed checking the spelling of the document when it was last saved. If this attribute is omitted, then its value is assumed to be dirty (not complete). [Example: Consider a WordprocessingML document saved by a hosting application whose spelling and grammar checking engines have completed checking grammar and spelling in the given WordprocessingML document. This state is specified using the following WordprocessingML in the document settings: <w:proofState w:spelling="clean" w:grammar="clean" /> The spelling attribute has the value clean specifying that the hosting application's spell checking engine completed checking the spelling of the given document when it was last saved. end example] The possible values for this attribute are defined by the ST_Proof simple type (§17.18.69). |
[Note: The W3C XML Schema definition of this element’s content model (CT_Proof) 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.