TabPropsRow property

Microsoft Visio Developer Reference

TabPropsRow property

   Example   

Returns the index of the Tab Properties row that contains tab formatting information for a Characters object.

Version added

3.0

Syntax

intRet = object.TabPropsRow(bias)

intRet

Integer. The index of the row that defines the Character object's formatting.

object

Required. An expression that returns a Characters object.

bias

Required Integer. The direction of the search.

Remarks

You can retrieve rows that represent runs of tab formatting by specifying a row index as an argument to the CellsSRC property of a shape. You can also view or change tab formats on the Tabs tab (click Text on the Format menu, and then click Tabs).

If the tab format for the Characters object is represented by more than one Tab Properties row, the TabPropsRow property returns -1. If the Characters object represents an insertion point rather than a sequence of characters (that is, if its Begin and End properties return the same value), use the bias argument to determine which row index to return.

Constant

Value

visBiasLetVisioChoose

0

visBiasLeft

1

visBiasRight

2

Specify visBiasLeft for the row that covers tab formatting for the character to the left of the insertion point. Use visBiasRight for the row that covers tab formatting for the character to the right of the insertion point.