GetFont(Int32) Method

Gets the font which controls the formatting properties in the string from the specified start index to the end of the string.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function GetFont( _
   ByVal startIndex As Integer _
) As FormattedStringFont

C#

public FormattedStringFont GetFont( 
   int startIndex
)

Parameters

startIndex

The index of the first character the returned font controls.

Return Value

A FormattedStringFont instance which controls the formatting of the end portion of the string.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	startIndex is less than zero.

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 FormattedStringFont is set.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, 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