IXpsOMPage::GetBleedBox method

Gets the dimensions of the page's bleed box.

Syntax


HRESULT GetBleedBox(
  [out, retval] XPS_RECT *bleedBox
);

Parameters

bleedBox [out, retval]

The dimensions of the bleed box.

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

bleedBox is NULL.

 

Remarks

The default bleed box of a page is:

XPS_RECT fieldDefault value
x0
y0
widthpageDimension.width
heightpageDimension.height

 

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

IXpsOMPage
XPS_RECT
XPS Document Errors
XML Paper Specification

 

 

Show: