Page Members (Visio)

Represents a drawing page, which can be either a foreground page or a background page.

Name

Description

AfterReplaceShapes

Occurs after a shape-replacement operation.

BeforePageDelete

Occurs before a page is deleted.

BeforeReplaceShapes

Occurs just before a shape-replacement operation.

BeforeSelectionDelete

Occurs before selected objects are deleted.

BeforeShapeDelete

Occurs before a shape is deleted.

BeforeShapeTextEdit

Occurs before a shape is opened for text editing in the user interface.

CalloutRelationshipAdded

Occurs when a new callout relationship is added to the page.

CalloutRelationshipDeleted

Occurs when a callout relationship is deleted from the page.

CellChanged

Occurs after the value changes in a cell in a document.

ConnectionsAdded

Occurs after connections have been established between shapes.

ConnectionsDeleted

Occurs after connections between shapes have been removed.

ContainerRelationshipAdded

Occurs when a new container relationship is added to the document.

ContainerRelationshipDeleted

Occurs when a container relationship is deleted from the document.

ConvertToGroupCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelConvertToGroup event.

FormulaChanged

Occurs after a formula changes in a cell in the object that receives the event.

GroupCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelGroup event.

PageChanged

Occurs after the name of a page, the background page associated with a page, or the page type (foreground or background) changes.

PageDeleteCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelPageDelete event.

QueryCancelConvertToGroup

Occurs before the application converts a selection of shapes to a group in response to a user action in the interface. If any event handler returns True, the operation is canceled.

QueryCancelGroup

Occurs before the application groups a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled.

QueryCancelPageDelete

Occurs before the application deletes a page in response to a user action in the interface. If any event handler returns True, the operation is canceled.

QueryCancelReplaceShapes

Occurs immediately after a shape-replacement operation is requested. If any event handler returns True, the operation is canceled.

QueryCancelSelectionDelete

Occurs before the application deletes a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled.

QueryCancelUngroup

Occurs before the application ungroups a selection of shapes in response to a user action in the interface. If any event handler returns True, the operation is canceled.

ReplaceShapesCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelReplaceShapes event.

SelectionAdded

Occurs after one or more shapes are added to a document.

SelectionDeleteCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelSelectionDelete event.

ShapeAdded

Occurs after one or more shapes are added to a document.

ShapeChanged

Occurs after a property of a shape that is not stored in a cell is changed in a document.

ShapeDataGraphicChanged

Occurs after a data graphic is applied to or deleted from a shape.

ShapeExitedTextEdit

Occurs after a shape is no longer open for interactive text editing.

ShapeLinkAdded

Occurs after a shape is linked to a data row.

ShapeLinkDeleted

Occurs after the link between a shape and a data row is deleted.

ShapeParentChanged

Occurs after shapes are grouped or a group is ungrouped.

TextChanged

Occurs after the text of a shape is changed in a document.

UngroupCanceled

Occurs after an event handler has returned True (cancel) to a QueryCancelUngroup event.

Name

Description

AddGuide

Adds a guide to a drawing page.

AutoConnectMany

Automatically draws multiple connections in the specified directions between the specified shapes. Returns the number of shapes connected.

AutoSizeDrawing

Automatically resizes the drawing page by adding as many printer-paper-sized tiles as necessary to fit all shapes in the drawing onto the page.

AvoidPageBreaks

Makes small adjustments to shapes to move them off page breaks.

BoundingBox

Returns a rectangle that tightly encloses the shapes of a page.

CenterDrawing

Centers a page's, master's, or group's shapes with respect to the extent of the page, master, or group. .

CreateSelection

Creates various types of Selection objects.

Delete

Deletes a Page object. Can also renumber remaining pages.

DrawArcByThreePoints

Creates a shape whose path consists of an arc defined by the three points passed as parameters.

DrawBezier

Creates a shape whose path is defined by the supplied sequence of Bezier control points.

DrawCircularArc

Creates a new shape whose path consists of a circular arc defined by its center, radius, and start and end angles.

DrawLine

Adds a line to the Shapes collection of a page.

DrawNURBS

Creates a new shape whose path consists of a single NURBS (nonuniform rational B-spline) segment.

DrawOval

Adds an oval (ellipse) to the Shapes collection of a page.

DrawPolyline

Creates a shape whose path is a polyline along a given set of points.

DrawQuarterArc

Creates a shape whose path consists of an elliptical arc defined by the two points and the flag passed in as arguments.

DrawRectangle

Adds a rectangle to the Shapes collection of a page, master, or group.

DrawSpline

Creates a new shape whose path follows a given sequence of points.

Drop

Creates one or more new Shape objects by dropping an object onto a receiving object such as a master, drawing page, shape, or group.

DropCallout

Creates a new callout Shape object on the page near the specified target shape, and associates the callout with the target shape. Returns the callout shape.

DropConnected

Creates a new Shape object on the page, places the new shape relative to the specified existing target shape, and adds a connector from the existing shape to the new shape. Returns the newly created shape.

DropContainer

Creates a new container Shape object on the page, places the container around the specified target shapes, and adds the target shapes to the container. Returns the container shape.

DropIntoList

Drops the specified object into the specified list at the specified position. Returns the newly dropped shape.

DropLegend

Inserts a data graphics legend on a Microsoft Visio drawing page. Returns the list shape instance specified in the OuterList parameter.

DropLinked

Returns a new shape on the drawing page linked to data in a data recordset.

DropMany

Creates one or more new Shape objects on a page. It returns an array of the IDs of the Shape objects it produces.

DropManyLinkedU

Creates multiple new shapes on the drawing page that are linked to multiple data rows in a data recordset. Returns the number of shape instances created and an array of IDs of those shapes.

DropManyU

Creates one or more new Shape objects on a page, in a master, or in a group. It returns an array of the IDs of the Shape objects it produces.

Duplicate

Duplicates the specified page and returns the new page.

Export

Exports an object from Microsoft Visio to a file format such as .bmp, .dib, .dwg, .dxf, .emf, .emz, .gif, .htm, .jpg, .png, .svg, .svgz, .tif, or .wmf.

GetCallouts

Returns the list of identifiers of the callout shapes on the page.

GetContainers

Returns an array of shape identifiers (IDs) of the container shapes on the page.

GetFormulas

Returns the formulas of many cells.

GetFormulasU

Returns the formulas of many cells.

GetResults

Gets the results or formulas of many cells.

GetShapesLinkedToData

Returns an array of all shapes on the active page linked to data in the specified data recordset.

GetShapesLinkedToDataRow

Returns an array of all shapes on the active page linked to data in the specified data row in the specified data recordset.

GetTheme

Returns a Variant that represents the specified theme component of the specified page.

GetThemeVariant

Returns the color, style, and embellishment, if any, of the variant of the theme applied to the specified page.

Import

Imports a file into the current document.

InsertFromFile

Adds a linked or embedded object to a page, master, or group.

InsertObject

Adds a new embedded object or ActiveX control to a page, master, or group.

Layout

Lays out the shapes and/or reroutes the connectors for the page, master, group, or selection.

LayoutChangeDirection

Revises the layout of a set of connected shapes on the page, by rotating or flipping a connected diagram without rotating or flipping the individual shapes.

LayoutIncremental

Makes small adjustments to the position of shapes on the drawing page to better align the shapes or to space them evenly from other shapes.

LinkShapesToDataRows

Links multiple rows in the specified data recordset, as specified by their data row IDs, to multiple shapes on the page, and optionally applies the current data graphic to the linked shapes.

OpenDrawWindow

Opens a new drawing window that displays a page.

Paste

Pastes the contents of the Clipboard into an object.

PasteSpecial

Inserts the contents of the Clipboard, allowing you to control the format of the pasted information and (optionally) establish a link to the source file (for example, a Microsoft Word document).

PasteToLocation

Pastes the shape to the specified location on the page.

Print

Prints the contents of an object to the default printer.

PrintTile

Prints a single tile of a drawing page.

ResizeToFitContents

Resizes the page, or the master's page, to fit tightly around the shapes or master that are on it.

SetFormulas

Sets the formulas of one or more cells.

SetResults

Sets the results or formulas of one or more cells.

SetTheme

Sets the theme for the specified page.

SetThemeVariant

Sets the color, style, and optionally the embellishment of the variant of the theme applied to the specified page.

ShapeIDsToUniqueIDs

Returns an array of unique IDs of shapes on the page, as specified by their shape IDs.

SplitConnector

Splits the specified connector with the specified shape. Returns the new duplicated connector.

UniqueIDsToShapeIDs

Returns an array of shape IDs of shapes on the page, as specifed by their unique IDs.

VisualBoundingBox

Name

Description

Application

Returns the instance of Microsoft Visio that is associated with an object. Read-only.

AutoSize

Determines whether Microsoft Visio automatically resizes the drawing page by adding printer-paper-sized sheets, as necessary, to fit the drawing's contents. Read/write.

Background

Determines whether a page is a background page. Read/write.

BackPage

Gets or sets the background page of a page. Read/write.

Comments

Returns a Comments object that represents the collection of all the reviewer comments on the page. Read-only.

Connects

Returns a Connects collection for a shape, page, or master. Read-only.

Document

Gets the Document object that is associated with an object. Read-only.

EventList

Returns the EventList collection of an object or the EventList collection that contains an Event object. Read-only.

ID

Gets the ID of an object. Read-only.

Index

Gets or sets the ordinal position of a page in a Pages collection. Read/write.

Layers

Returns the Layers collection of an object. Read-only.

LayoutRoutePassive

Determines whether to enable advanced connector routing logic on the page. Read/write.

Name

Specifies the name of an object. Read-only.

NameU

Specifies the universal name of a Page object. Read/write.

ObjectType

Returns an object's type. Read-only.

OLEObjects

Returns the OLEObjects collection of a page. Read-only.

OriginalPage

Returns the Page object that represents the original Microsoft Visio drawing page that was marked up on separate markup overlays by reviewers of the drawing. Read-only.

PageSheet

Returns the page sheet (an object that represents the ShapeSheet spreadsheet) of a page. Read-only.

PersistsEvents

Indicates whether an object is capable of containing persistent events in its EventList collection. Read-only.

Picture

Returns a picture that represents an enhanced metafile (EMF) contained in a master, shape, selection, or page. Read-only.

PrintTileCount

Returns the number of print tiles for a drawing page. Read-only.

ReviewerID

Gets the reviewer ID associated with the markup overlay. Read-only.

ShapeComments

Returns a Comments object that represents the collection of all the reviewer comments on all the shapes on the page. Read-only.

Shapes

Returns the Shapes collection for a page, master, or group. Read-only.

SpatialSearch

Returns a Selection object whose shapes meet certain criteria in relation to a point that is expressed in the coordinate space of a page, master, or group. Read-only.

Stat

Returns status information for an object. Read-only.

ThemeColors

Gets or sets the current theme colors for the page. Read/write.

ThemeEffects

Gets or sets the current theme effect for the page. Read/write.

Type

Returns the type of the object. Read-only.

Show:
© 2014 Microsoft