Share via

PreviewPicture Property [Visio 2003 SDK Documentation]

  • Article

Gets or sets the preview picture shown in the Open dialog box or the Choose Drawing Type pane.

objRet = object**.PreviewPicture**

object**.PreviewPicture** = objExpression

objRet     An IPictureDisp object that represents current preview picture.

object     Required. An expression that returns a Document object.

objExpression     Required. An IPictureDisp object that represents the new preview picture.

Version added

2002

Remarks

The PreviewPicture property returns and accepts only EMF files (enhanced metafiles). Microsoft Office Visio will raise an exception if objExpression contains a non-EMF file.

To delete an existing preview, set the PreviewPicture property to Nothing.

You can use the PreviewPicture property to include a preview picture in a template that does not have any diagrams stored in it.

COM provides a standard implementation of a picture object that has the IPictureDisp interface on top of the underlying system picture support. The IPictureDisp interface exposes a picture object's properties and is implemented in the stdole type library as a StdPicture object creatable within Microsoft Visual Basic. The stdole type library is automatically referenced from all Visual Basic for Applications (VBA) projects in Visio.

To get information about the StdPicture object that supports the IPictureDisp interface:

  1. On the Tools menu, point to Macros, and then click Visual Basic Editor.
  2. On the View menu, click Object Browser.
  3. In the Project/Library list, click stdole.
  4. Under Classes, examine the class named StdPicture.

For details about the IPictureDisp interface, see the Microsoft Platform SDK on MSDN, the Microsoft Developer Network.

Currently, only in-process solutions can use the PreviewPicture property because the IPictureDisp interface cannot be marshaled.

Applies to | Document object