Edit

Share via

IXpsOMCanvas::GetUseAliasedEdgeMode method (xpsobjectmodel.h)

  • Article

Gets a Boolean value that determines whether the edges of the objects in the canvas are to be rendered using the aliased edge mode.

Syntax

HRESULT GetUseAliasedEdgeMode(
  [out, retval] BOOL *useAliasedEdgeMode
);

Parameters

[out, retval] useAliasedEdgeMode

The Boolean value that determines whether the objects in the canvas are to be rendered using the aliased edge mode.

Value Meaning
TRUE
 The edges of objects in the canvas are to be rendered without anti-aliasing using the aliased edge mode. This includes any objects in the canvas that have useAliasedEdgeMode set to FALSE.

In the document markup, this corresponds to the RenderOptions.EdgeMode attribute having a value of Aliased.
FALSE
 The edges of objects in the canvas are to be rendered in the default manner.

In the document markup, this corresponds to the RenderOptions.EdgeMode attribute being absent.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK
 The method succeeded.
E_POINTER
 useAliasedEdgeMode is NULL.

Remarks

The property that is returned by this method corresponds to the RenderOptions.EdgeMode attribute of the Canvas element in the document markup.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header xpsobjectmodel.h

See also

IXpsOMCanvas

XML Paper Specification

XPS Document Errors