Expand Minimize

IXpsOMPath interface

Describes a non-text visual item.

When to implement

Never. Custom implementation of this interface is not supported.

Members

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

Methods

The IXpsOMPath interface has these methods.

MethodDescription
Clone

Makes a deep copy of the interface.

GetAccessibilityLongDescription

Gets the long (detailed) textual description of the object's contents.

GetAccessibilityShortDescription

Gets the short textual description of the object's contents.

GetFillBrush

Gets a pointer to the resolved IXpsOMBrush interface that contains the fill brush for the path.

GetFillBrushLocal

Gets a pointer to the local, unshared IXpsOMBrush interface that contains the fill brush for the path.

GetFillBrushLookup

Gets the lookup key of the brush that is stored in a resource dictionary and used as the fill brush for the path.

GetGeometry

Gets a pointer to the path's IXpsOMGeometry interface, which describes the resolved fill area for this path.

GetGeometryLocal

Gets the local, unshared geometry of the resolved fill area for this path.

GetGeometryLookup

Gets the lookup key of a shared geometry object that is stored in a resource dictionary and that describes the resolved fill area for this path.

GetSnapsToPixels

Gets a Boolean value that indicates whether the path is to be snapped to device pixels when the path is rendered.

GetStrokeBrush

Gets a pointer to the resolved IXpsOMBrush interface that contains the stroke brush that has been set for the path.

GetStrokeBrushLocal

Gets a pointer to the local, unshared IXpsOMBrush interface that contains the stroke brush for the path.

GetStrokeBrushLookup

Gets the lookup key of the brush that is stored in a resource dictionary and is to be used as the stroke brush for the path.

GetStrokeDashCap

Gets the style of the end cap to be used on the stroke dash.

GetStrokeDashes

Gets a pointer to the IXpsOMDashCollection interface that contains the XPS_DASH structures that define the dash pattern of the stroke.

GetStrokeDashOffset

Gets the offset from the origin of the stroke to the starting point of the dash array pattern.

GetStrokeEndLineCap

Gets the style of the stroke line's end cap.

GetStrokeLineJoin

Gets the style for joining stroke lines.

GetStrokeMiterLimit

Gets the miter limit value that is set for the stroke.

GetStrokeStartLineCap

Gets the style of the line cap at the start of the stroke line.

GetStrokeThickness

Gets the stroke thickness.

SetAccessibilityLongDescription

Sets the long (detailed) textual description of the object's contents.

SetAccessibilityShortDescription

Sets the short textual description of the object's contents.

SetFillBrushLocal

Sets the pointer to the local, unshared IXpsOMBrush interface to be used as the fill brush.

SetFillBrushLookup

Sets the lookup key name of a shared brush in a resource dictionary, to be used as the fill brush.

SetGeometryLocal

Sets the pointer to the local, unshared IXpsOMGeometry interface that contains the geometry of the resolved fill area to be set for this path.

SetGeometryLookup

Sets the lookup key name of a shared geometry in a resource dictionary.

SetSnapsToPixels

Sets a Boolean value that indicates whether the path will be snapped to device pixels when that path is being rendered.

SetStrokeBrushLocal

Sets a pointer to a local, unshared IXpsOMBrush interface to be used as a stroke brush.

SetStrokeBrushLookup

Sets the lookup key name of a shared brush to be used as the stroke brush.

SetStrokeDashCap

Sets the style of the stroke's dash cap.

SetStrokeDashOffset

Sets the offset from the origin of the stroke to the starting point of the dash array pattern.

SetStrokeEndLineCap

Sets the style of the stroke line's end cap.

SetStrokeLineJoin

Sets the style for joining stroke lines.

SetStrokeMiterLimit

Sets the miter limit of the path.

SetStrokeStartLineCap

Sets the style of the stroke's line cap at the start of the stroke line.

SetStrokeThickness

Sets the stroke thickness.

 

Remarks

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



IXpsOMPath    *newInterface;

// 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->CreatePath (&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

See also

IXpsOMObjectFactory::CreatePath
Interfaces
XML Paper Specification

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.