Determines an appropriate font to use to render the range of text.
'Declaration
Public Overloads Function MapCharacters( _
ByVal As TextAnalysisSource, _
ByVal As System.Integer, _
ByVal As System.Integer, _
ByVal As FontCollection, _
ByVal As System.String, _
ByVal As FontWeight, _
ByVal As FontStyle, _
ByVal As FontStretch, _
ByRef As System.Integer, _
ByRef As System.Single _
) As Font
public Font MapCharacters(
TextAnalysisSource ,
System.int ,
System.int ,
FontCollection ,
System.string ,
FontWeight ,
FontStyle ,
FontStretch ,
out System.int ,
out System.float
)
Parameters
- source
- The text source implementation holds the text and locale.
- textPosition
- Starting position to analyze.
- textLength
- Length of the text to analyze.
- baseFontCollection
- Default font collection to use.
- baseFamilyName
- Family name of the base font. If you pass null, no matching will be done against the family.
- baseWeight
- Desired weight.
- baseStyle
- Desired style.
- baseStretch
- Desired stretch.
- mappedLength
- Length of text mapped to the mapped font. This will always be less or equal to the input text length and greater than zero (if the text length is non-zero) so that the caller advances at least one character each call.
- scale
- Scale factor to multiply the em size of the returned font by.
Return Value
The font that should be used to render the first mappedLength characters of the text. If it returns NULL, then no known font can render the text, and mappedLength is the number of unsupported characters to skip.