Export (0) Print
Expand All

IXpsOMPage::SetContentBox method

Sets the dimensions of the page's content box.

Syntax


HRESULT SetContentBox(
  [in]  const XPS_RECT *contentBox
);

Parameters

contentBox [in]

The dimensions of the page's content box.

contentBox fieldValid values
contentBox.widthGreater than or equal to 0.0 and less than or equal to (pageDimensions.width - contentBox.x).
contentBox.heightGreater than or equal to 0.0 and less than or equal to (pageDimensions.height - contentBox.y).
contentBox.xGreater than or equal to 0.0 and less than pageDimensions.width.
contentBox.yGreater than or equal to 0.0 and less than pageDimensions.height.

 

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

contentBox is NULL.

XPS_E_INVALID_CONTENT_BOX

The rectangle specified by contentBox contains one or more values that are not valid.

 

Remarks

The content box specifies where ink appears on the page.

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

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft