Description property

Microsoft Visio Developer Reference

Description property

       

Gets or sets the value of the Description box in a Document object's properties or a shape's Hyperlink object.

Version added

2.0

Syntax

strRet = object.Description
object.Description = stringExpression

strRet

String. The current value of the field.

object

Required. An expression that returns a Document or Hyperlink object.

stringExpression

Required String. The new value for the field.

Remarks

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

Setting a hyperlink's Description property is equivalent to entering information in the optional Description box in the Hyperlinks dialog box (click Hyperlinks on the Insert menu). It is also equivalent to setting the result of the Description cell of the shape's Hyperlink.Row row.