Compatibility Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Compatibility Settings.

This class is available in Office 2007 and above.

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

public class Compatibility : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Compatibility = class
    inherit OpenXmlCompositeElement

Public Class Compatibility
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Compatibility

Remarks

[ISO/IEC 29500-1 1st Edition]

compat (Compatibility Settings)

This element specifies a set of optional compatibility options for the current document.

[Example: Consider a WordprocessingML document with a series of compatibility settings:

<w:settings>  
  <w:compat>  
    …  </w:compat>  
</w:settings>  

The compat element specifies the set of compatibility settings for a document. end example]

Parent Elements
settings (§17.15.1.78)

Child Elements	Subclause
adjustLineHeightInTable (Add Document Grid Line Pitch To Lines in Table Cells)	§17.15.3.1
applyBreakingRules (Use Legacy Ethiopic and Amharic Line Breaking Rules)	§17.15.3.2
balanceSingleByteDoubleByteWidth (Balance Single Byte and Double Byte Characters)	§17.15.3.3
compatSetting (Custom Compatibility Setting)	§17.15.3.4
doNotExpandShiftReturn (Don't Justify Lines Ending in Soft Line Break)	§17.15.3.5
doNotLeaveBackslashAlone (Display Backslash As Yen Sign)	§17.15.3.6
spaceForUL (Add Additional Space Below Baseline For Underlined East Asian Text)	§17.15.3.7
ulTrailSpace (Underline All Trailing Spaces)	§17.15.3.8

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

AdjustLineHeightInTable	Add Document Grid Line Pitch To Lines in Table Cells. Represents the following element tag in the schema: w:adjustLineHeightInTable.
AlignTablesRowByRow	Align Table Rows Independently. Represents the following element tag in the schema: w:alignTablesRowByRow.
AllowSpaceOfSameStyleInTable	Allow Contextual Spacing of Paragraphs in Tables. Represents the following element tag in the schema: w:allowSpaceOfSameStyleInTable.
ApplyBreakingRules	Use Legacy Ethiopic and Amharic Line Breaking Rules. Represents the following element tag in the schema: w:applyBreakingRules.
AutofitToFirstFixedWidthCell	Allow Table Columns To Exceed Preferred Widths of Constituent Cells. Represents the following element tag in the schema: w:autofitToFirstFixedWidthCell.
AutoSpaceLikeWord95	Emulate Word 95 Full-Width Character Spacing. Represents the following element tag in the schema: w:autoSpaceLikeWord95.
BalanceSingleByteDoubleByteWidth	Balance Single Byte and Double Byte Characters. Represents the following element tag in the schema: w:balanceSingleByteDoubleByteWidth.
CachedColumnBalance	Use Cached Paragraph Information for Column Balancing. Represents the following element tag in the schema: w:cachedColBalance.
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ConvertMailMergeEscape	Treat Backslash Quotation Delimiter as Two Quotation Marks. Represents the following element tag in the schema: w:convMailMergeEsc.
DisplayHangulFixedWidth	Always Use Fixed Width for Hangul Characters. Represents the following element tag in the schema: w:displayHangulFixedWidth.
DoNotAutofitConstrainedTables	Do Not AutoFit Tables To Fit Next To Wrapped Objects. Represents the following element tag in the schema: w:doNotAutofitConstrainedTables.
DoNotBreakConstrainedForcedTable	Don't Break Table Rows Around Floating Tables. Represents the following element tag in the schema: w:doNotBreakConstrainedForcedTable.
DoNotBreakWrappedTables	Do Not Allow Floating Tables To Break Across Pages. Represents the following element tag in the schema: w:doNotBreakWrappedTables.
DoNotExpandShiftReturn	Don't Justify Lines Ending in Soft Line Break. Represents the following element tag in the schema: w:doNotExpandShiftReturn.
DoNotLeaveBackslashAlone	Convert Backslash To Yen Sign When Entered. Represents the following element tag in the schema: w:doNotLeaveBackslashAlone.
DoNotSnapToGridInCell	Do Not Snap to Document Grid in Table Cells with Objects. Represents the following element tag in the schema: w:doNotSnapToGridInCell.
DoNotSuppressIndentation	Do Not Ignore Floating Objects When Calculating Paragraph Indentation. Represents the following element tag in the schema: w:doNotSuppressIndentation.
DoNotSuppressParagraphBorders	Do Not Suppress Paragraph Borders Next To Frames. Represents the following element tag in the schema: w:doNotSuppressParagraphBorders.
DoNotUseEastAsianBreakRules	Do Not Compress Compressible Characters When Using Document Grid. Represents the following element tag in the schema: w:doNotUseEastAsianBreakRules.
DoNotUseHTMLParagraphAutoSpacing	Use Fixed Paragraph Spacing for HTML Auto Setting. Represents the following element tag in the schema: w:doNotUseHTMLParagraphAutoSpacing.
DoNotUseIndentAsNumberingTabStop	Ignore Hanging Indent When Creating Tab Stop After Numbering. Represents the following element tag in the schema: w:doNotUseIndentAsNumberingTabStop.
DoNotVerticallyAlignCellWithShape	Don't Vertically Align Cells Containing Floating Objects. Represents the following element tag in the schema: w:doNotVertAlignCellWithSp.
DoNotVerticallyAlignInTextBox	Ignore Vertical Alignment in Textboxes. Represents the following element tag in the schema: w:doNotVertAlignInTxbx.
DoNotWrapTextWithPunctuation	Do Not Allow Hanging Punctuation With Character Grid. Represents the following element tag in the schema: w:doNotWrapTextWithPunct.
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)
FootnoteLayoutLikeWord8	Emulate Word 6.x/95/97 Footnote Placement. Represents the following element tag in the schema: w:footnoteLayoutLikeWW8.
ForgetLastTabAlignment	Ignore Width of Last Tab Stop When Aligning Paragraph If It Is Not Left Aligned. Represents the following element tag in the schema: w:forgetLastTabAlignment.
GrowAutofit	Allow Tables to AutoFit Into Page Margins. Represents the following element tag in the schema: w:growAutofit.
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)
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)
LayoutRawTableWidth	Ignore Space Before Table When Deciding If Table Should Wrap Floating Object. Represents the following element tag in the schema: w:layoutRawTableWidth.
LayoutTableRowsApart	Allow Table Rows to Wrap Inline Objects Independently. Represents the following element tag in the schema: w:layoutTableRowsApart.
LineWrapLikeWord6	Emulate Word 6.0 Line Wrapping for East Asian Text. Represents the following element tag in the schema: w:lineWrapLikeWord6.
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MacWordSmallCaps	Emulate Word 5.x for the Macintosh Small Caps Formatting. Represents the following element tag in the schema: w:mwSmallCaps.
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
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)
NoColumnBalance	Do Not Balance Text Columns within a Section. Represents the following element tag in the schema: w:noColumnBalance.
NoExtraLineSpacing	Do Not Center Content on Lines With Exact Line Height. Represents the following element tag in the schema: w:noExtraLineSpacing.
NoLeading	Do Not Add Leading Between Lines of Text. Represents the following element tag in the schema: w:noLeading.
NoSpaceRaiseLower	Do Not Increase Line Height for Raised/Lowered Text. Represents the following element tag in the schema: w:noSpaceRaiseLower.
NoTabHangIndent	Do Not Create Custom Tab Stop for Hanging Indent. Represents the following element tag in the schema: w:noTabHangInd.
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
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)
PrintBodyTextBeforeHeader	Print Body Text before Header/Footer Contents. Represents the following element tag in the schema: w:printBodyTextBeforeHeader.
PrintColorBlackWhite	Print Colors as Black And White without Dithering. Represents the following element tag in the schema: w:printColBlack.
SelectFieldWithFirstOrLastChar	Select Field When First or Last Character Is Selected. Represents the following element tag in the schema: w:selectFldWithFirstOrLastChar.
ShapeLayoutLikeWord8	Emulate Word 97 Text Wrapping Around Floating Objects. Represents the following element tag in the schema: w:shapeLayoutLikeWW8.
ShowBreaksInFrames	Display Page/Column Breaks Present in Frames. Represents the following element tag in the schema: w:showBreaksInFrames.
SpaceForUnderline	Add Additional Space Below Baseline For Underlined East Asian Text. Represents the following element tag in the schema: w:spaceForUL.
SpacingInWholePoints	Only Expand/Condense Text By Whole Points. Represents the following element tag in the schema: w:spacingInWholePoints.
SplitPageBreakAndParagraphMark	Always Move Paragraph Mark to Page after a Page Break. Represents the following element tag in the schema: w:splitPgBreakAndParaMark.
SubFontBySize	Increase Priority Of Font Size During Font Substitution. Represents the following element tag in the schema: w:subFontBySize.
SuppressBottomSpacing	Ignore Exact Line Height for Last Line on Page. Represents the following element tag in the schema: w:suppressBottomSpacing.
SuppressSpacingAtTopOfPage	Ignore Minimum Line Height for First Line on Page. Represents the following element tag in the schema: w:suppressSpacingAtTopOfPage.
SuppressSpacingBeforeAfterPageBreak	Do Not Use Space Before On First Line After a Page Break. Represents the following element tag in the schema: w:suppressSpBfAfterPgBrk.
SuppressTopSpacing	Ignore Minimum and Exact Line Height for First Line on Page. Represents the following element tag in the schema: w:suppressTopSpacing.
SuppressTopSpacingWordPerfect	Emulate WordPerfect 5.x Line Spacing. Represents the following element tag in the schema: w:suppressTopSpacingWP.
SwapBordersFacingPages	Swap Paragraph Borders on Odd Numbered Pages. Represents the following element tag in the schema: w:swapBordersFacingPages.
TruncateFontHeightsLikeWordPerfect	Emulate WordPerfect 6.x Font Height Calculation. Represents the following element tag in the schema: w:truncateFontHeightsLikeWP6.
UnderlineTabInNumberingList	Underline Following Character Following Numbering. Represents the following element tag in the schema: w:underlineTabInNumList.
UnderlineTrailingSpaces	Underline All Trailing Spaces. Represents the following element tag in the schema: w:ulTrailSpace.
UseAltKinsokuLineBreakRules	Use Alternate Set of East Asian Line Breaking Rules. Represents the following element tag in the schema: w:useAltKinsokuLineBreakRules.
UseAnsiKerningPairs	Use ANSI Kerning Pairs from Fonts. Represents the following element tag in the schema: w:useAnsiKerningPairs.
UseFarEastLayout	Do Not Bypass East Asian/Complex Script Layout Code. Represents the following element tag in the schema: w:useFELayout.
UseNormalStyleForList	Do Not Automatically Apply List Paragraph Style To Bulleted/Numbered Text. Represents the following element tag in the schema: w:useNormalStyleForList.
UsePrinterMetrics	Use Printer Metrics To Display Documents. Represents the following element tag in the schema: w:usePrinterMetrics.
UseSingleBorderForContiguousCells	Use Simplified Rules For Table Border Conflicts. Represents the following element tag in the schema: w:useSingleBorderforContiguousCells.
UseWord2002TableStyleRules	Emulate Word 2002 Table Style Rules. Represents the following element tag in the schema: w:useWord2002TableStyleRules.
UseWord97LineBreakRules	Emulate Word 97 East Asian Line Breaking. Represents the following element tag in the schema: w:useWord97LineBreakRules.
WordPerfectJustification	Emulate WordPerfect 6.x Paragraph Justification. Represents the following element tag in the schema: w:wpJustification.
WordPerfectSpaceWidth	Space width. Represents the following element tag in the schema: w:wpSpaceWidth.
WrapTrailSpaces	Line Wrap Trailing Spaces. Represents the following element tag in the schema: w:wrapTrailSpaces.
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

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)
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)
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)
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 OpenXmlElement)

Explicit Interface Implementations

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