Table of contents
TOC
Collapse the table of content
Expand the table of content

Page.GetContainers Method (Visio)

office 365 dev account|Last Updated: 6/12/2017
|
1 Contributor

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

Syntax

expression . GetContainers( NestedOptions )

expression A variable that represents a Page object.

Parameters

NameRequired/OptionalData TypeDescription
NestedOptionsRequiredVisContainerNestedIndicates whether to exclude shapes in nested containers. See Remarks for possible values.

Return Value

Long()

Remarks

The NestedOptions parameter must be one of the following VisContainerNested constants.

ConstantValueDescription
visContainerIncludeNested0Include shapes that are in nested containers.
visContainerExcludeNested1Exclude shapes that are in nested containers.

You can use the Shapes.ItemFromID property to get the actual shapes from the IDs returned by GetContainers .

Example

The following Visual Basic for Applications (VBA) example shows how to use the GetContainers method to get the IDs of all the containers on a page, loop through those containers, and print each container name in the Immediate window. The example includes nested containers.

For Each containerID In vsoPage.GetContainers(visContainerIncludeNested)
    Set vsoContainerShape = vsoPage.Shapes.ItemFromID(containerID)
    Debug.Print vsoContainerShape.NameU
Next
© 2017 Microsoft