Page.GetContainers method (Visio)

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

Name Required/Optional Data type Description
NestedOptions Required VisContainerNested Indicates 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.

Constant Value Description
visContainerIncludeNested 0 Include shapes that are in nested containers.
visContainerExcludeNested 1 Exclude 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

Support and feedback

Have questions or feedback about Office VBA or this documentation? Please see Office VBA support and feedback for guidance about the ways you can receive support and provide feedback.