TabPropsRow Property [Visio 2003 SDK Documentation]
Returns the index of the row in the Tabs section of the ShapeSheet that contains tab formatting information for a Characters object.
intRet = object**.TabPropsRow**(BiasLOrR)**
intRet Integer. The index of the row that defines the Characters object's formatting.
object Required. An expression that returns a Characters object.
BiasLOrR Required Integer. The direction of the search.
Version added
3.0
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. Under these circumstances, Microsoft Office Visio ignores the value of the BiasLorR argument. (Two paragraphs that have the same tab formatting share the same row in the ShapeSheet. Visio creates a new ShapeSheet row only when tab formatting changes, for example from left-aligned to right-aligned.)
If the Characters object spans several characters within the same tab properties row, ParaPropsRow returns the index of that row. In this case as well, Visio ignores the BiasLorR argument.
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 BiasLOrR 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.
If you specify visBiasLetVisioChoose, Visio uses the same logic it would apply to new text typed in the user interface starting at the insertion point. Usually, that means that Visio will apply the tab formatting of the character to the left of the insertion point to the new text, so TabPropsRow will return the same value it would if passed visBiasLeft. (For an explanation of the meaning of "left" in this context, see the following note.) However, if the insertion point is at the beginning of a new paragraph, TabPropsRow returns the value it would return if passed visBiasRight.
Note In the context of a Characters object, "left" means logically prior. In other words, one character is to the "left" of another if it would have been typed first in the course of normal writing. It is necessary to make this distinction because in some languages, characters are normally written from right to left, and not from left to right.
Applies to | Characters object
See Also | CharPropsRow property | ParaPropsRow property