Document.Description Property

  • Article
Visio Automation Reference

Gets or sets the description of a document, one of a document's properties. Read/write.

Version Information
 Version Added:  Visio 2.0

Syntax

expression.Description

expression   A variable that represents a Document object.

Return Value
String

Remarks

Setting a document's Description property is equivalent to entering information in the Description box in the Properties dialog box (File menu).

Security  Use this feature with caution. Sensitive or confidential information could be revealed to other users.

Example

This Microsoft Visual Basic for Applications (VBA) macro shows how to use the Description property to document the description of a drawing. It adds a Document object to the Documents collection and sets the Document object's Description property as well as other document properties.

Before running this macro, substitute your own values for the items in italic in the following code. To verify that these properties have been set, open the Properties dialog box (File menu).

Visual Basic for Applications 
  
Public Sub Description_Example() 

Dim vsoDocument As Visio.Document 

Set vsoDocument = Documents.Add("") 

'Set the properties of the document. 
vsoDocument.Title = "<em>document title</em>" 
vsoDocument.Creator = "<em>author name</em>" 
vsoDocument.Description = "<em>document description</em>" 
vsoDocument.Keywords = "<em>keyword1, keyword2, keyword3</em>" 
vsoDocument.Subject = "<em>document subject</em>" 
vsoDocument.Manager = "<em>manager name</em>" 
vsoDocument.Category = "<em>document category</em>" 



End Sub

See Also