IXpsOMPage::SetBleedBox method (xpsobjectmodel.h)

Sets the dimensions of the page's bleed box.

Syntax

HRESULT SetBleedBox(
  [in] const XPS_RECT *bleedBox
);

Parameters

[in] bleedBox

The dimensions of the page's bleed box. This parameter must not be NULL.

A valid bleed box has the following properties:

####### x)) ≤ value )

####### y)) ≤ value )

0)
0)

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
bleedBox is NULL.
XPS_E_INVALID_BLEED_BOX
The rectangle described by bleedBox contains one or more values that are not valid.

Remarks

The bleed box dimensions are not checked against the page dimensions until the page is serialized.

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

IXpsOMPage

XML Paper Specification

XPS Document Errors

XPS_RECT