Graphics.MeasureCharacterRanges Method (String, Font, RectangleF, StringFormat)

 

Gets an array of Region objects, each of which bounds a range of character positions within the specified string.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

member MeasureCharacterRanges : 
        text:string *
        font:Font *
        layoutRect:RectangleF *
        stringFormat:StringFormat -> Region[]

Parameters

text
Type: System.String

String to measure.

font
Type: System.Drawing.Font

Font that defines the text format of the string.

layoutRect
Type: System.Drawing.RectangleF

RectangleF structure that specifies the layout rectangle for the string.

stringFormat
Type: System.Drawing.StringFormat

StringFormat that represents formatting information, such as line spacing, for the string.

Return Value

Type: System.Drawing.Region[]

This method returns an array of Region objects, each of which bounds a range of character positions within the specified string.

The regions returned by this method are resolution-dependent, so there might be a slight loss of accuracy if strings are recorded in a metafile at one resolution and later played back at a different resolution.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgse, which is a parameter of the Paint event handler. The code performs the following actions:

  • Sets a string "First and Second ranges" and a font for display of the string ("Times New Roman", 16 point).

  • Sets two character ranges within the string (which correspond to the words "First" and "Second").

  • Creates a rectangle in which to display the string.

  • Sets the formatting of the string ¾ including the two character ranges.

  • Draws the string to the screen.

  • Measures the character ranges, determines rectangles that bound the two specified ranges.

  • Draws the two rectangles to the screen.

The result is the displayed string with the first range ("First") bounded by a red rectangle and the second range ("Second") bounded by a blue rectangle.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 1.1
Return to top
Show: