DocumentExtensions Class
Provides methods you can use to extend Microsoft Office Word documents by generating host items for Document objects and by testing for the existence of the generated host items.
Inheritance Hierarchy
System.Object
Microsoft.Office.Tools.Word.Extensions.DocumentExtensions
Namespace: Microsoft.Office.Tools.Word.Extensions
Assembly: Microsoft.Office.Tools.Word.v4.0.Utilities (in Microsoft.Office.Tools.Word.v4.0.Utilities.dll)
Syntax
'Declaration
<ExtensionAttribute> _
Public NotInheritable Class DocumentExtensions
public static class DocumentExtensions
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") .gif "Static member") |
GetVstoObject(_Document, ApplicationFactory) | Returns a Microsoft.Office.Tools.Word.Document host item that extends the functionality of the current Document object in an application-level add-in. Pass the Globals.Factory object in your project to the factory parameter. |
|
GetVstoObject(_Document, Factory) | Returns a Microsoft.Office.Tools.Word.Document host item that extends the functionality of the current Document object in a document-level customization. Pass the Globals.Factory object in your project to the factory parameter. |
|
HasVstoObject(_Document, ApplicationFactory) | Returns a value that indicates whether a Microsoft.Office.Tools.Word.Document host item has been created for the current Document object in an application-level add-in. Pass the Globals.Factory object in your project to the factory parameter. |
|
HasVstoObject(_Document, Factory) | Returns a value that indicates whether a Microsoft.Office.Tools.Word.Document host item has been created for the current Document object in a document-level customization. Pass the Globals.Factory object in your project to the factory parameter. |
Top
Remarks
The DocumentExtensions class contains extension methods that are designed to be accessed on Document objects. For more information about extension methods, see Extension Methods (C# Programming Guide) and Extension Methods (Visual Basic).
The extension methods in the DocumentExtensions class are provided for backward compatibility with Office projects that you retarget from the .NET Framework 3.5 to the .NET Framework 4 or the .NET Framework 4.5. In new projects that target the .NET Framework 4 or the .NET Framework 4.5, you should call the GetVstoObject and HasVstoObject methods that are provided by the Globals.Factory object in your project. For more information, see Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time and Programming Document-Level Customizations.
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.
See Also
Reference
Microsoft.Office.Tools.Word.Extensions Namespace
Other Resources
Extending Word Documents and Excel Workbooks in Application-Level Add-ins at Run Time
Programming Document-Level Customizations