Document.Compatibility Property

Gets a value that indicates whether the specified compatibility option is enabled.

Namespace:  Microsoft.Office.Tools.Word
Assemblies:   Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
  Microsoft.Office.Tools.Word (in Microsoft.Office.Tools.Word.dll)

Syntax

'Declaration
ReadOnly Property Compatibility As Document_CompatibilityType
Document_CompatibilityType Compatibility { get; }

Property Value

Type: Microsoft.Office.Tools.Word.Document_CompatibilityType
true if the specified compatibility option is enabled; otherwise, false.

Remarks

The Compatibility property is intended to be used with the following parameter.

Parameter

Description

Type

One of the WdCompatibility values that specifies the compatibility option to check for.

If you use the Compatibility property without specifying a parameter, it returns a Document_CompatibilityType object that is not intended to be used directly from your code.

Compatibility options affect how a document is displayed in Microsoft Office Word. Some of the WdCompatibility values might not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed.

Examples

The following code example suppresses the space before a paragraph if the paragraph is located after a hard page break. This example is for an application-level add-in.

Private Sub DocumentCompatibility()
    Dim vstoDoc As Document = Globals.Factory.GetVstoObject(Me.Application.ActiveDocument)
    vstoDoc.Compatibility(Word.WdCompatibility.wdSuppressSpBfAfterPgBrk) = True 
End Sub
private void DocumentCompatibility()
{
    Document vstoDoc = Globals.Factory.GetVstoObject(this.Application.ActiveDocument);
    vstoDoc.Compatibility[Word.WdCompatibility.wdSuppressSpBfAfterPgBrk] = true;
}

.NET Framework Security

See Also

Reference

Document Interface

Microsoft.Office.Tools.Word Namespace