IterationMode property

  • Article

IterationMode property

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

See also         Example         Applies to

Controls whether a Selection object reports subselected shapes and groups in which a shape is selected.

Version added

2000

Syntax

        
          intRet = object.IterationMode
      
        
          object
          .IterationMode = intExpression

intRet

Long. Mode of the selection.

object

Required. An expression that returns a Selection object.

intExpression

Required Long. Bit mask indicating whether sub- and super-selected items should be reported.

Remarks

The items in a Selection object are a subset of the descendants of the Selection object's containing shape.

  • A top-level shape in a Selection object is an immediate child of the selection's containing shape.
  • A subselected shape in a Selection object is not an immediate child of the selection's containing shape.
  • A superselected shape in a Selection object has at least one immediate child that is subselected.

If a shape is subselected, then each of its ancestors—except the containing shape itself—is superselected.

The value of the IterationMode property is a combination of the following values.

Constant

Value

Description

visSelModeSkipSuper

&H0100

Selection does not report superselected shapes.

visSelModeOnlySuper

&H0200

Selection only reports superselected shapes.

visSelModeSkipSub

&H0400

Selection does not report subselected shapes.

visSelModeOnlySub

&H0800

Selection only reports subselected shapes.

When a Selection object is created, its initial iteration mode is visSelModeSkipSub + visSelModeSkipSuper. It reports neither subselected nor superselected shapes and behaves identically to Selection objects in versions of Visio prior to Visio 2000.

You can determine whether an individual item in a Selection object is a subselected or superselected item using the ItemStatus property.