• Article

TextBox.GetRectFromCharacterIndex Method (Int32)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns a rectangle for the leading edge of the character at the specified index.

Namespace:  System.Windows.Controls
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
<EditorBrowsableAttribute(EditorBrowsableState.Never)> _
Public Function GetRectFromCharacterIndex ( _
    charIndex As Integer _
) As Rect

[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public Rect GetRectFromCharacterIndex(
    int charIndex
)

Parameters

  • charIndex
    Type: System.Int32
    A zero-based character index of the character for which to retrieve the rectangle.

Return Value

Type: System.Windows.Rect
A rectangle for the leading edge of the character at the specified character index, or Empty if a bounding rectangle cannot be determined.

Remarks

Because this method returns a rectangle that represents an edge of the character, the width of the rectangle is 0.

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.