ActiveWritingStyle Class
Grammar Checking Settings.When the object is serialized out as xml, its qualified name is w:activeWritingStyle.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.ActiveWritingStyle
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class ActiveWritingStyle _
Inherits OpenXmlLeafElement
'Usage
Dim instance As ActiveWritingStyle
public class ActiveWritingStyle : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.1.1 activeWritingStyle (Grammar Checking Settings)
This element specifies information about the parameters of the grammar checking which was performed on the contents of the current WordprocessingML document. [Note: This information can be used as desired by applications; for example, to determine if the current grammar checking state, specified by the proofState element (§17.15.1.65) is sufficient. end note]
[Example: Consider the following WordprocessingML fragment from the document settings:
<w:activeWritingStyle w:lang="en-CA" w:vendorID="64" w:dllVersion="131078" w:nlCheck="1" w:checkStyle="0" />
The activeWritingStyle element's lang attribute specifies that the English (Canada) language setting for grammatical and stylistic checks must be applied; the vendorID attribute specifies information about the vendor associated with the DLL used to perform the grammatical and stylistic checks; the dllVersion attribute specifies the version of this DLL; the nlCheck attribute specifies if natural language checks were performed or not; and the checkStyle attribute specifies that the hosting application should allow its grammar engine to check both the grammar and style of the given WordprocessingML document, if that functionality is available. end example]
Parent Elements |
|---|
settings (§17.15.1.78) |
Attributes |
Description |
|---|---|
appName (Application Name) |
Specifies the name of the application which specified the grammatical settings contained on the attributes for this element. If an application reads these settings and does not understand the value of this attribute, then its settings can be ignored and the application's default settings used instead. [Example: Consider the WordprocessingML below: <w:activeWritingStyle … w:appName="testApp"/> The appName attribute has a value of testApp, specifying that the application called testApp specified the grammar checking rules of the given WordprocessingML document. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
checkStyle (Check Stylistic Rules With Grammar) |
Specifies if the grammar content checking performed on this document included stylistic rules for the document content. If specified, applications which support this functionality shall check stylistic rules as well as grammatical ones when checking the grammatical content of this document. [Example: Consider the WordprocessingML below: <w:activeWritingStyle … w:checkStyle="false"/> The checkStyle attribute has a value of false, specifying that hosting applications must only check grammatical rules of the given WordprocessingML document. end example] The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
dllVersion (Grammatical Check Engine Version) |
Specifies the version of the engine that was used to check the grammatical content of the WordprocessingML document. [Example: Consider the following WordprocessingML fragment: <w:activeWritingStyle … w:dllVersion="131078" /> The dllVersion attribute specifies that the writing style DLL version used to check the writing style of is the writing style DLL version associated with the string 131078. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
lang (Writing Style Language) |
Specifies the language of the engine used to perform the grammatical content checking. [Example: Consider the following WordprocessingML fragment: <w:activeWritingStyle w:lang="en-CA" …/> The lang attribute has a value of en-CA, therefore the grammatical check language is specified as English (en) and Canada (CA), resulting in use of the English (Canada) grammar checker. end example] The possible values for this attribute are defined by the ST_Lang simple type (§22.9.2.6). |
nlCheck (Natural Language Grammar Check) |
Specifies whether the engine that was used to check the grammatical content of the WordprocessingML document performed natural language-based analysis. [Example: Consider the WordprocessingML below: <w:activeWritingStyle … w:nlCheck="1" /> The nlCheck attribute has a value of 1, specifying that the writing style DLL supported natural language analysis . end example]. The possible values for this attribute are defined by the ST_OnOff simple type (§22.9.2.7). |
vendorID (Grammatical Engine ID) |
Specifies a value indicating a unique ID for the writing style engine that was used to check the grammatical content of the WordprocessingML document. [Example: Consider the WordprocessingML below: <w:activeWritingStyle … w:vendorID="64"/> The vendorId attribute has a value of 64, specifying that the grammatical checker used is identified by the string 64.end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
[Note: The W3C XML Schema definition of this element’s content model (CT_WritingStyle) 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.