BackPage property

Microsoft Visio Developer Reference

BackPage property

   Example   

Gets or sets the background page of a page.

Version added

2.0

Syntax

objVariantRet = object.BackPage
object.BackPage = stringVariant

objVariantRet

Variant. A Page object that represents the background page.

object

Required. An expression that returns a Page object.

stringVariant

Required Variant. A string that names the new background page.

Remarks

If a page has no background, its BackPage property returns an empty Variant. Otherwise the returned Variant refers to a Page object—the background page of the indicated page.

To assign a background page to a page, set the page's BackPage property to the name of the background page you want to assign. To cause a page to have no background page, pass an empty string to the BackPage property.

Note In earlier versions of Visio (through version 4.1), the BackPage property returned an object (as opposed to a Variant of type object) and it accepted a string (as opposed to a Variant of type string). The property has been modified so that it accepts and returns variants due to changes in Automation support tools. For backward compatibility, the BackPageAsObj and BackPageFromName properties have been added. These properties have the same signatures and occupy the same vtable slots as the earlier version of the BackPage property.