GetFont(Int32,Int32) Method

Gets the font which controls the formatting properties in the string from the specified start index for the specified number of characters.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function GetFont( _
   ByVal startIndex As Integer, _
   ByVal length As Integer _
) As FormattedTextFont

C#

public FormattedTextFont GetFont( 
   int startIndex,
   int length
)

Parameters

startIndex

The index of the first character the returned font controls.

length

The number of characters after the start index controlled by the returned font.

Return Value

A FormattedTextFont instance which controls the formatting of a portion of the string.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	startIndex is less than zero.
System.ArgumentOutOfRangeException	length is less than one. A zero length string cannot be controlled by a formatting font.

Remarks

If the start index is greater than or equal to the length of the unformatted string, no exception will be thrown. It will be thrown later when one of the formatting properties of the returned FormattedTextFont is set.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2