Share via


Keywords Property [Visio 2003 SDK Documentation]

Gets or sets the value of the Keywords box in a document's Properties dialog box.

strRet = object**.Keywords**

object**.Keywords** = stringExpression

strRet     String. The current string of keywords.

object     Required. An expression that returns a Document object.

stringExpression     Required String. The new string of keywords.

Version added

2.0

Remarks

Setting the Keywords property is equivalent to entering information in the Keywords 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 Keywords property to document the keywords that help locate a drawing. It adds a Document object to the Documents collection and sets the Document object's Keywords property as well as other document properties.

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

Public Sub Keywords_Example() 

   Dim vsoDocument As Visio.Document 

    Set vsoDocument = Documents.Add("") 

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

End Sub  

Applies to | Document object

See Also | Category property | Company property | Creator property | Description property | HyperlinkBase property | Manager property | Subject property | Title property