Share via

DocumentExtensions.HasVstoObject Method (_Document, Factory)

  • Article

Returns a value that indicates whether a Microsoft.Office.Tools.Word.Document host item has been created for the current Microsoft.Office.Interop.Word.Document object in a document-level customization. Pass the Globals.Factory object in your project to the factory parameter.

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 Shared Function HasVstoObject ( _
    document As _Document, _
    factory As Factory _
) As Boolean

public static bool HasVstoObject(
    this _Document document,
    Factory factory
)

Parameters

  • document
    Type: Microsoft.Office.Interop.Word._Document
    The native document object to test. Do not supply this parameter yourself. When you call this method on a Word document, the runtime supplies this parameter.
  • factory
    Type: Microsoft.Office.Tools.Word.Factory
    An object that provides access to certain features in your document-level customization. Pass the Globals.Factory object to this parameter.

Return Value

Type: System.Boolean
true if a Microsoft.Office.Tools.Word.Document host item has been created for the current Microsoft.Office.Interop.Word.Document object; otherwise, false.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type _Document. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

In a document-level customization, this method returns true only if the Microsoft.Office.Interop.Word.Document object on which you call this method is the underlying object of a Microsoft.Office.Tools.Word.Document host item in the current customization. Otherwise, this method returns false.

This method is provided for backward compatibility with Office projects that you retarget from the .NET Framework 3.5 to the .NET Framework 4. In new projects that target the .NET Framework 4, you should call the HasVstoObject method that is provided by the Globals.Factory object in your project. For more information, see Getting Extended Objects from Native Office Objects in Document-Level Customizations.

Note

The Document parameter is of type Microsoft.Office.Interop.Word._Document, which is the parent interface of Microsoft.Office.Interop.Word.Document. Therefore, this method extends both types: Microsoft.Office.Interop.Word._Document and Microsoft.Office.Interop.Word.Document. Typically, when you reference a Word document, you use a Microsoft.Office.Interop.Word.Document.

.NET Framework Security

See Also

Reference

DocumentExtensions Class

HasVstoObject Overload

Microsoft.Office.Tools.Word.Extensions Namespace

Other Resources

Getting Extended Objects from Native Office Objects in Document-Level Customizations

Extension Methods (C# Programming Guide)

Extension Methods (Visual Basic)