IndexInStencil property

Microsoft Visio Developer Reference

IndexInStencil property

See also   Example   

Contains the index of a master or master shortcut object within its stencil.

Version added

2000

Syntax

intRet = object.IndexInStencil
object.IndexInStencil = intExpression

intRet

Integer. The index of the object within its stencil.

object

Required. An expression that returns a Master or MasterShortcut object.

intExpression

Required Integer. The new index of the object within its stencil.

Remarks

Beginning with Visio 2000, the document stencil window shows all Master and MasterShortcut objects in a Visio document. The Visio object model exposes the Master and MasterShortcut objects in a Document object as two distinct collections. The index returned by a Master object is its index with respect to other Master objects in its Document object and is unrelated to the presence or absence of MasterShortcut objects in the document. The index returned by a MasterShortcut object is its index with respect to other MasterShortcut objects in its Document object and is unrelated to the presence or absence of Master objects in the document.

Use the IndexInStencil property to maintain the relative order of Master and MasterShortcut objects when considered as a single collection.