Share via

DocumentLibraryVersions Object

  • Article
Office Developer Reference

The DocumentLibraryVersions property of the Document object in Microsoft Office Word 2003 or Microsoft Office Word 2007, the Workbook object in Microsoft Office Excel 2003 or Microsoft Office Excel 2007 , and the Presentation object in Microsoft Office PowerPoint 2003 or Microsoft Office Excel 2007 returns a DocumentLibraryVersions object. The DocumentLibraryVersions object represents a collection of DocumentLibraryVersion objects.

Remarks

Use the DocumentLibraryVersions object with documents stored in a SharePoint document library on the server to determine whether versioning is enabled for the active document and, if versioning is enabled, to manage the document's collection of DocumentLibraryVersion objects.

Each DocumentLibraryVersion object represents one saved version of the active document. When versioning is enabled, a new version is created on the server when the actions listed below occur; additional versions are not created each time the user saves changes to the open document.

  • Check In
  • Save - A new version is created on the server when the user first saves the document after opening it. Additional changes saved while the document is open apply to the same version.
  • Restore
  • Upload

The DocumentLibraryVersions object model is available whether versioning is enabled or disabled on the active document. The DocumentLibraryVersions property of the Document, Workbook and Presentation objects does not return Nothing when the active document is not stored in a document library or versioning is not enabled. Use the IsVersioningEnabled property to determine whether the document library is configured to save a backup copy, or version, each time the document is edited on the Web site.

Example
The following example checks to see whether versioning is enabled for the active document and, if so, displays information about each saved version.

Visual Basic for Applications 
  Dim dlvVersions As Office.DocumentLibraryVersions
    Dim dlvVersion As Office.DocumentLibraryVersion
    Dim strVersionInfo As String
    Set dlvVersions = ActiveDocument.DocumentLibraryVersions
    If dlvVersions.IsVersioningEnabled Then
        strVersionInfo = "This document has " & _
            dlvVersions.Count & " versions: " & vbCrLf
        For Each dlvVersion In dlvVersions
            strVersionInfo = strVersionInfo & _
                " - Version #: " & dlvVersion.Index & vbCrLf & _
                "  - Modified by: " & dlvVersion.ModifiedBy & vbCrLf & _
                "  - Modified on: " & dlvVersion.Modified & vbCrLf & _
                "  - Comments: " & dlvVersion.Comments & vbCrLf
        Next
    Else
        strVersionInfo = "Versioning not enabled for this document."
    End If
    MsgBox strVersionInfo, vbInformation + vbOKOnly, "Version Information"
    Set dlvVersion = Nothing
    Set dlvVersions = Nothing

See Also