Characters.ParaPropsRow Property
| Visio Automation Reference |
Returns the index of the row in the Paragraph section of a ShapeSheet window that contains paragraph-formatting information for a Characters object. Read-only.
Version Information
Version Added: Visio 3.0
Syntax
expression.ParaPropsRow(BiasLorR)
expression A variable that represents a Characters object.
Parameters
| Name | Required/Optional | Data Type | Description |
|---|---|---|---|
| BiasLorR | Required | Integer | The direction of the search. |
Return Value
Integer
Remarks
If the formatting for the Characters object is represented by more than one row in the Paragraph section in the ShapeSheet window (in other words, if the Characters object consists of a sequence of characters that spans paragraphs that are formatted differently), the ParaPropsRow property returns -1. Under these circumstances, Microsoft Office Visio ignores the value of the BiasLorR argument. (Two paragraphs that have the same paragraph formatting share the same row in the ShapeSheet. Visio creates a new ShapeSheet row only when paragraph formatting changes, for example from left-aligned to right-aligned.)
If the Characters object spans several characters within the same paragraph 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 (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 paragraph formatting for the character to the left of the insertion point or visBiasRight for the row that covers paragraph 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 paragraph formatting of the character to the left of the insertion point to the new text, so ParaPropsRow 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, ParaPropsRow returns the value it would return if passed visBiasRight.
.gif "ms196206.vs_note(en-us,office.12).gif") 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. |
See Also