Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

How to: Reference Documents in the Documents Collection

Applies to

The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office.

Project type

  • Document-level projects

  • Application-level projects

Microsoft Office version

  • Word 2003

  • Word 2007

For more information, see Features Available by Application and Project Type.

You can refer to a Document object as a member of the Documents collection by using the name of the document or its index value in the collection.

Referring to a document by its name is usually the better choice if you want to work with a specific document. You rarely refer to a document by using its index value in the Documents collection because this value can change for a given document as other documents are opened and closed.

To reference a document by its name

  • Set an object variable to point to the named document, SampleDoc.doc. To use the following code example, run the code from the ThisDocument or ThisAddIn class in your project.

    object fileName = "SampleDoc.doc"; 
    Word.Document doc = Application.Documents.get_Item(ref fileName); 
    

If you want to refer to the active document (the document that has focus), you can use the ActiveDocument property of the Application object.

To reference the active document

  • Retrieve the name of the active document using ActiveDocument. To use the following code example, run the code from the ThisDocument or ThisAddIn class in your project.

    string documentName = Application.ActiveDocument.Name;
    

If you are only working with the document that is associated with a document-level customization, you can use the Globals.ThisDocument reference from anywhere in the project when you need to refer to the document that has the focus.

To reference the document associated with a document-level customization

  • Retrieve the name of the document using Globals.ThisDocument.

    string documentName2 = Globals.ThisDocument.Name;
    

Community Additions

ADD
Show:
© 2015 Microsoft