This documentation is archived and is not being maintained.

IndexInStencil Property [Visio 2003 SDK Documentation]

Office 2003

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

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.

Version added

2000

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.

Note  Beginning with Microsoft Office Visio 2003, only custom (user-created) stencils are editable. By default, Visio stencils (stencils that are shipped on the Microsoft Office Visio CD) are not editable. However, by setting the AllowEditing property to True, you can override this behavior to allow editing of built-in stencils.





Show: