Settings Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Document Settings.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is w:settings.

public class Settings : DocumentFormat.OpenXml.OpenXmlPartRootElement

type Settings = class
    inherit OpenXmlPartRootElement

Public Class Settings
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

Settings

Remarks

[ISO/IEC 29500-1 1st Edition]

settings (Document Settings)

This element specifies the settings that are applied to a WordprocessingML document. This element is the root element of the Document Settings part in a WordprocessingML document.

[Example: Consider the following WordprocessingML fragment for the settings part of a document:

<w:settings>  
  <w:defaultTabStop w:val="720" />  
  <w:characterSpacingControl w:val="doNotCompress" />  
</w:settings>  

The settings element contains all of the settings for this document. In this case, the two settings applied are automatic tab stop increments of 0.5" using the defaultTabStop element, and no character level whitespace compression using the characterSpacingControl element. end example]

Parent Elements
Root element of WordprocessingML Document Settings part

Child Elements	Subclause
activeWritingStyle (Grammar Checking Settings)	§17.15.1.1
alignBordersAndEdges (Align Paragraph and Table Borders with Page Border)	§17.15.1.2
alwaysMergeEmptyNamespace (Do Not Mark Custom XML Elements With No Namespace As Invalid)	§17.15.1.3
alwaysShowPlaceholderText (Use Custom XML Element Names as Default Placeholder Text)	§17.15.1.4
attachedSchema (Attached Custom XML Schema)	§17.15.1.5
attachedTemplate (Attached Document Template)	§17.15.1.6
autoFormatOverride (Allow Automatic Formatting to Override Formatting Protection Settings)	§17.15.1.9
autoHyphenation (Automatically Hyphenate Document Contents When Displayed)	§17.15.1.10
bookFoldPrinting (Book Fold Printing)	§17.15.1.11
bookFoldPrintingSheets (Number of Pages Per Booklet)	§17.15.1.12
bookFoldRevPrinting (Reverse Book Fold Printing)	§17.15.1.13
bordersDoNotSurroundFooter (Page Border Excludes Footer)	§17.15.1.14
bordersDoNotSurroundHeader (Page Border Excludes Header)	§17.15.1.15
captions (Caption Settings)	§17.15.1.17
characterSpacingControl (Character-Level Whitespace Compression)	§17.15.1.18
clickAndTypeStyle (Paragraph Style Applied to Automatically Generated Paragraphs)	§17.15.1.19
clrSchemeMapping (Theme Color Mappings)	§17.15.1.20
compat (Compatibility Settings)	§17.15.1.21
consecutiveHyphenLimit (Maximum Number of Consecutively Hyphenated Lines)	§17.15.1.22
decimalSymbol (Radix Point for Field Code Evaluation)	§17.15.1.23
defaultTableStyle (Default Table Style for Newly Inserted Tables)	§17.15.1.24
defaultTabStop (Distance Between Automatic Tab Stops)	§17.15.1.25
displayBackgroundShape (Display Background Objects When Displaying Document)	§17.15.1.26
displayHorizontalDrawingGridEvery (Distance between Horizontal Gridlines)	§17.15.1.27
displayVerticalDrawingGridEvery (Distance between Vertical Gridlines)	§17.15.1.28
documentProtection (Document Editing Restrictions)	§17.15.1.29
documentType (Document Classification)	§17.15.1.30
docVars (Document Variables)	§17.15.1.32
doNotAutoCompressPictures (Do Not Automatically Compress Images)	§17.15.1.33
doNotDemarcateInvalidXml (Do Not Show Visual Indicator For Invalid Custom XML Markup)	§17.15.1.34
doNotDisplayPageBoundaries (Do Not Display Visual Boundary For Header/Footer or Between Pages)	§17.15.1.35
doNotEmbedSmartTags (Remove Smart Tags When Saving)	§17.15.1.36
doNotHyphenateCaps (Do Not Hyphenate Words in ALL CAPITAL LETTERS)	§17.15.1.37
doNotIncludeSubdocsInStats (Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics)	§17.15.1.38
doNotShadeFormData (Do Not Show Visual Indicator For Form Fields)	§17.15.1.39
doNotTrackFormatting (Do Not Track Formatting Revisions When Tracking Revisions)	§17.15.1.40
doNotTrackMoves (Do Not Use Move Syntax When Tracking Revisions)	§17.15.1.41
doNotUseMarginsForDrawingGridOrigin (Do Not Use Margins for Drawing Grid Origin)	§17.15.1.42
doNotValidateAgainstSchema (Do Not Validate Custom XML Markup Against Schemas)	§17.15.1.43
drawingGridHorizontalOrigin (Drawing Grid Horizontal Origin Point)	§17.15.1.44
drawingGridHorizontalSpacing (Drawing Grid Horizontal Grid Unit Size)	§17.15.1.45
drawingGridVerticalOrigin (Drawing Grid Vertical Origin Point)	§17.15.1.46
drawingGridVerticalSpacing (Drawing Grid Vertical Grid Unit Size)	§17.15.1.47
embedSystemFonts (Embed Common System Fonts)	§17.8.3.7
embedTrueTypeFonts (Embed TrueType Fonts)	§17.8.3.8
endnotePr (Document-Wide Endnote Properties)	§17.11.4
evenAndOddHeaders (Different Even/Odd Page Headers and Footers)	§17.10.1
footnotePr (Document-Wide Footnote Properties)	§17.11.12
forceUpgrade (Upgrade Document on Open)	§17.15.1.48
formsDesign (Structured Document Tag Placeholder Text Should be Resaved)	§17.15.1.49
gutterAtTop (Position Gutter At Top of Page)	§17.15.1.50
hideGrammaticalErrors (Do Not Display Visual Indication of Grammatical Errors)	§17.15.1.51
hideSpellingErrors (Do Not Display Visual Indication of Spelling Errors)	§17.15.1.52
hyphenationZone (Hyphenation Zone)	§17.15.1.53
ignoreMixedContent (Ignore Mixed Content When Validating Custom XML Markup)	§17.15.1.54
linkStyles (Automatically Update Styles From Document Template)	§17.15.1.55
listSeparator (List Separator for Field Code Evaluation)	§17.15.1.56
mailMerge (Mail Merge Settings)	§17.14.20
mathPr (Math Properties)	§22.1.2.62
mirrorMargins (Mirror Page Margins)	§17.15.1.57
noLineBreaksAfter (Custom Set of Characters Which Cannot End a Line)	§17.15.1.58
noLineBreaksBefore (Custom Set Of Characters Which Cannot Begin A Line)	§17.15.1.59
noPunctuationKerning (Never Kern Punctuation Characters)	§17.15.1.60
printFormsData (Only Print Form Field Content)	§17.15.1.61
printFractionalCharacterWidth (Print Fractional Character Widths)	§17.15.1.62
printPostScriptOverText (Print PostScript Codes With Document Text)	§17.15.1.63
printTwoOnOne (Print Two Pages Per Sheet)	§17.15.1.64
proofState (Spelling and Grammatical Checking State)	§17.15.1.65
readModeInkLockDown (Freeze Document Layout)	§17.15.1.66
removeDateAndTime (Remove Date and Time from Annotations)	§17.15.1.67
removePersonalInformation (Remove Personal Information from Document Properties)	§17.15.1.68
revisionView (Visibility of Annotation Types)	§17.15.1.69
rsids (Listing of All Revision Save ID Values)	§17.15.1.72
saveFormsData (Only Save Form Field Content)	§17.15.1.73
saveInvalidXml (Allow Saving Document As XML File When Custom XML Markup Is Invalid)	§17.15.1.74
savePreviewPicture (Generate Thumbnail For Document On Save)	§17.15.1.75
saveSubsetFonts (Subset Fonts When Embedding)	§17.8.3.15
saveThroughXslt (Custom XSL Transform To Use When Saving As XML File)	§17.15.1.76
saveXmlDataOnly (Only Save Custom XML Markup)	§17.15.1.77
schemaLibrary (Embedded Custom XML Schema Supplementary Data)	§23.2.2
showEnvelope (Show E-Mail Message Header)	§17.15.1.79
showXMLTags (Show Visual Indicators for Custom XML Markup Start/End Locations)	§17.15.1.80
smartTagType (Supplementary Smart Tag Information)	§17.15.1.81
strictFirstAndLastChars (Use Strict Kinsoku Rules for Japanese Text)	§17.15.1.82
styleLockQFSet (Prevent Replacement of Styles Part)	§17.15.1.83
styleLockTheme (Prevent Modification of Themes Part)	§17.15.1.84
stylePaneFormatFilter (Suggested Filtering for List of Document Styles)	§17.15.1.85
stylePaneSortMethod (Suggested Sorting for List of Document Styles)	§17.15.1.86
summaryLength (Percentage of Document to Use When Generating Summary)	§17.15.1.87
themeFontLang (Theme Font Languages)	§17.15.1.88
trackRevisions (Track Revisions to Document)	§17.15.1.89
updateFields (Automatically Recalculate Fields on Open)	§17.15.1.90
useXSLTWhenSaving (Save Document as XML File through Custom XSL Transform)	§17.15.1.91
view (Document View Setting)	§17.15.1.92
writeProtection (Write Protection)	§17.15.1.93
zoom (Magnification Setting)	§17.15.1.94

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

� ISO/IEC29500: 2008.

Constructors

Settings()	Initializes a new instance of the Settings class.
Settings(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Settings class with the specified child elements.
Settings(OpenXmlElement[])	Initializes a new instance of the Settings class with the specified child elements.
Settings(String)	Initializes a new instance of the Settings class from outer XML.

Properties

AlignBorderAndEdges	Align Paragraph and Table Borders with Page Border. Represents the following element tag in the schema: w:alignBordersAndEdges.
BordersDoNotSurroundFooter	Page Border Excludes Footer. Represents the following element tag in the schema: w:bordersDoNotSurroundFooter.
BordersDoNotSurroundHeader	Page Border Excludes Header. Represents the following element tag in the schema: w:bordersDoNotSurroundHeader.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
DisplayBackgroundShape	Display Background Objects When Displaying Document. Represents the following element tag in the schema: w:displayBackgroundShape.
DocumentSettingsPart	Gets the DocumentSettingsPart associated with this element.
DoNotDisplayPageBoundaries	Do Not Display Visual Boundary For Header/Footer or Between Pages. Represents the following element tag in the schema: w:doNotDisplayPageBoundaries.
EmbedSystemFonts	Embed Common System Fonts. Represents the following element tag in the schema: w:embedSystemFonts.
EmbedTrueTypeFonts	Embed TrueType Fonts. Represents the following element tag in the schema: w:embedTrueTypeFonts.
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
GutterAtTop	Position Gutter At Top of Page. Represents the following element tag in the schema: w:gutterAtTop.
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
HideGrammaticalErrors	Do Not Display Visual Indication of Grammatical Errors. Represents the following element tag in the schema: w:hideGrammaticalErrors.
HideSpellingErrors	Do Not Display Visual Indication of Spelling Errors. Represents the following element tag in the schema: w:hideSpellingErrors.
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
MirrorMargins	Mirror Page Margins. Represents the following element tag in the schema: w:mirrorMargins.
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OpenXmlPart	Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PrintFormsData	Only Print Form Field Content. Represents the following element tag in the schema: w:printFormsData.
PrintFractionalCharacterWidth	Print Fractional Character Widths. Represents the following element tag in the schema: w:printFractionalCharacterWidth.
PrintPostScriptOverText	Print PostScript Codes With Document Text. Represents the following element tag in the schema: w:printPostScriptOverText.
RemoveDateAndTime	Remove Date and Time from Annotations. Represents the following element tag in the schema: w:removeDateAndTime.
RemovePersonalInformation	Remove Personal Information from Document Properties. Represents the following element tag in the schema: w:removePersonalInformation.
SaveFormsData	Only Save Form Field Content. Represents the following element tag in the schema: w:saveFormsData.
SaveSubsetFonts	Subset Fonts When Embedding. Represents the following element tag in the schema: w:saveSubsetFonts.
View	Document View Setting. Represents the following element tag in the schema: w:view.
WriteProtection	Write Protection. Represents the following element tag in the schema: w:writeProtection.
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
Zoom	Magnification Setting. Represents the following element tag in the schema: w:zoom.

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
Load(DocumentSettingsPart)	Loads the DOM from the DocumentSettingsPart
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Reload()	Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
Save()	Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement)
Save(DocumentSettingsPart)	Saves the DOM into the DocumentSettingsPart.
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlPartRootElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)