IXpsOMGlyphs interface

Article
06/01/2017

Describes the text that appears on a page.

The IXpsOMGlyphsEditor interface is used to modify the text that is described by this interface.

When to implement

Never. Custom implementation of this interface is not supported.

Members

The IXpsOMGlyphs interface inherits from IXpsOMVisual. IXpsOMGlyphs also has these types of members:

Methods

Methods

The IXpsOMGlyphs interface has these methods.

Method	Description
Clone	Makes a deep copy of the interface.
GetBidiLevel	Gets the level of bidirectional text.
GetDeviceFontName	Gets the name of the device font.
GetFillBrush	Gets a pointer to the resolved IXpsOMBrush interface of the fill brush to be used for the text.
GetFillBrushLocal	Gets a pointer to the local, unshared IXpsOMBrush interface of the fill brush to be used for the text.
GetFillBrushLookup	Gets the lookup key of the IXpsOMBrush interface that is stored in a resource dictionary and will be used as the fill brush.
GetFontFaceIndex	Gets the index of the font face to be used.
GetFontRenderingEmSize	Gets the font size.
GetFontResource	Gets a pointer to the IXpsOMFontResource interface of the font resource object required for this text.
GetGlyphIndexCount	Gets the number of Glyph indices.
GetGlyphIndices	Gets an array of XPS_GLYPH_INDEX structures that describe the specific glyph indices in the font.
GetGlyphMappingCount	Gets the number of glyph mappings.
GetGlyphMappings	Gets an array of XPS_GLYPH_MAPPING structures that describe how to map UTF-16 scalar values to entries in the array of XPS_GLYPH_INDEX structures, which is returned by GetGlyphIndices.
GetGlyphsEditor	Gets a pointer to the IXpsOMGlyphsEditor interface that will be used to edit the glyphs in the object.
GetIsSideways	Gets a Boolean value that indicates whether the text is to be rendered with the glyphs rotated sideways.
GetOrigin	Gets the starting position of the text.
GetProhibitedCaretStopCount	Gets the number of prohibited caret stops.
GetProhibitedCaretStops	Gets an array of prohibited caret stop locations.
GetStyleSimulations	Gets the style simulations that will be applied when rendering the glyphs.
GetUnicodeString	Gets the text in unescaped UTF-16 scalar values.
SetFillBrushLocal	Sets the IXpsOMBrush interface pointer to a local, unshared fill brush.
SetFillBrushLookup	Sets the lookup key name of a shared fill brush.
SetFontFaceIndex	Sets the index of the font face to be used.
SetFontRenderingEmSize	Sets the font size of the text.
SetFontResource	Sets the pointer to the IXpsOMFontResource interface of the font resource object that is required for this text.
SetOrigin	Sets the starting position of the text.
SetStyleSimulations	Sets the style simulations that will be applied when the glyphs are rendered.

Remarks

The code example that follows illustrates how to create an instance of this interface.

IXpsOMGlyphs       *newInterface;
// this interface is defined outside of this example
//  IXpsOMFontResource *font; 

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateGlyphs (font, &newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}

Requirements

Minimum supported client	Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps \| Windows Store apps]
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps \| Windows Store apps]
Header	Xpsobjectmodel.h
IDL	XpsObjectModel.idl