Compartir a través de


IXpsOMPage::GetContentBox method

Gets the dimensions of the page's content box.

Syntax

HRESULT GetContentBox(
  [out, retval] XPS_RECT *contentBox
);

Parameters

  • contentBox [out, retval]
    The dimensions of the content 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 code Description
S_OK

The method succeeded.

E_POINTER

contentBox is NULL.

 

Remarks

The content box indicates where ink appears on the page.

The default content box of a page is

XPS_RECT field Default value
x 0
y 0
width pageDimension.width
height pageDimension.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