CharPropsRow property

Microsoft Visio Developer Reference

CharPropsRow property

   Example   

Returns the index of the row in the Character section of a ShapeSheet window that contains character formatting information for a Characters object.

Version added

3.0

Syntax

intRet = object.CharPropsRow(bias)

intRet

Integer. The index of the row that defines the Characters object's format.

object

Required. An expression that returns a Characters object.

bias

Required Integer. The direction of the search.

Remarks

If the formatting of the Characters object is represented by more than one row in the Character section of the ShapeSheet window, the CharPropsRow 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

visBiasLeft

1

visBiasRight

2

visBiasLetVisioChoose

0

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