IXpsOMCanvas::GetUseAliasedEdgeMode method

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

useAliasedEdgeMode [out, retval]

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

ValueMeaning
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 codeDescription
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

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

IXpsOMCanvas
XPS Document Errors
XML Paper Specification

 

 

Show: