Share via


IXRGlyphs::GetUnicodeString (Compact 2013)

3/28/2014

This method retrieves the Unicode string to render in glyphs.

Syntax

virtual HRESULT STDMETHODCALLTYPE GetUnicodeString(
    WCHAR* *pUnicodeString
) = 0;

Parameters

  • pUnicodeString
    [out] Pointer to a Unicode string with XAML-compatible encoding.

Return Value

Returns an HRESULT that indicates success or failure.

Remarks

IXRGlyphs does not have a content property; therefore, you do not define glyphs by declaring text as the inner text of an IXRGlyphs object. Instead, you specify the individual glyphs through either a Unicode string or glyph indices, by calling IXRGlyphs::SetUnicodeString or IXRGlyphs::SetIndices. Of these methods, SetUnicodeString is probably the most common because it is the easiest to use to capture a Unicode string from the output of different applications that are used to compose text. You can use SetUnicodeString to specify the basic glyph information and can then adjust values in the glyph indices by using SetIndices to refine the advance and offset spacing within the set of glyphs.

pUnicodeString only supports a one-to-one mapping of Unicode points to glyphs. To show surrogates or double-byte characters in multibyte languages, use SetIndices.

.NET Framework Equivalent

System.Windows.Documents.Glyphs.UnicodeString

Requirements

Header

XamlRuntime.h

sysgen

SYSGEN_XAML_RUNTIME

See Also

Reference

IXRGlyphs
IXRGlyphs::SetUnicodeString