WD: WordBasic Examples: LockDocument, LockDocument()

ID: Q106316

The information in this article applies to:

Microsoft Word for Windows, versions 6.0, 6.0a, 6.0c
Microsoft Word for Windows 95, versions 7.0. 7.0a
Microsoft Word for Windows NT, verison 6.0
Word for the Macintosh, versions 6.0, 6.0.1

SUMMARY

This article contains a sample macro that demonstrates the use of the following WordBasic statements or functions:

   LockDocument

   LockDocument()

This article supplements the information in online Help. To open this Help topic in Word for Windows, click Contents on the Help menu and then choose the "Programming with Microsoft Word" topic. In Word for the Macintosh, click the Help icon, select Microsoft Word Help and choose the "Programming with Microsoft Word" topic.

MORE INFORMATION

Microsoft provides programming examples for illustration only, without warranty either expressed or implied, including, but not limited to, the implied warranties of merchantability and/or fitness for a particular purpose. This article assumes that you are familiar with the programming language being demonstrated and the tools used to create and debug procedures. Microsoft support professionals can help explain the functionality of a particular procedure, but they will not modify these examples to provide added functionality or construct procedures to meet your specific needs. If you have limited programming experience, you may want to contact the Microsoft fee-based consulting line at (800) 936-5200. For more information about the support options available from Microsoft, please see the following page on the World Wide Web:

   http://www.microsoft.com/supportnet/refguide/

LockDocument

LockDocument()

Syntax:

LockDocument LockDocument()

Example:

This macro produces a Master document and creates two subdocuments. Word inserts a padlock icon in the left margin to indicate the first subdocument is locked then displays a message using the LockDocument() function before removing the files it created.

   Sub MAIN
      If SelInfo(27) = - 1 Then FileNew
      ViewMasterDocument
      Insert "This is a Master document"
      InsertPara
      FileSaveAs .Name = "C:\MACROMST.DOC", .AddToMru = 1
      CreateSubdocument
      LineDown 2
      LineUp 1
      Insert "This is Sub document1."
      FileSaveAs .Name = "C:\MSSUB1.DOC", .AddToMru = 1
      LineDown 2
      CreateSubdocument
      LineDown 1
      Insert "This is Sub document2."
      FileSaveAs .Name = "C:\MSSUB2.DOC", .AddToMru = 1
      LineUp 3
      MsgBox "Word will now lock sub document1. Note the padlock on the \ 
      left."
      LockDocument
      If LockDocument() = - 1 Then
         MsgBox "The File is now locked. Choose OK to resume demo."
         MsgBox "Word will now unlock sub document1. Note the padlock \ 
         is no longer there."
         LockDocument
      End If
      FileClose 1
      Kill "C:\MACROMST.DOC"
      Kill "C:\SUB1.DOC"
      Kill "C:\SUB2.DOC"
   End Sub

NOTE: Word for the Macintosh users, the path information in this macro is in Word for Windows format. For the macro to work correctly, change the path statements to a Macintosh format.

Additional query words:

Keywords          : kbprg kbdtacode wordnt kbmacroexample winword ntword macword word6 word7 word95 
Version           : WINDOWS:6.0,6.0a,6.0c,7.0,7.0a; MACINTOSH:6.0,6.0.1,6.0.1a
Platform          : MACINTOSH Win95 WINDOWS winnt
Issue type        : kbhowto kbinfo

Last Reviewed: April 9, 1999