IXpsOMPage::SetContentBox method (xpsobjectmodel.h)
Sets the dimensions of the page's content box.
Syntax
HRESULT SetContentBox(
[in] const XPS_RECT *contentBox
);
Parameters
[in] contentBox
The dimensions of the page's content box.
| contentBox field | Valid values |
|---|---|
| contentBox.width | Greater than or equal to 0.0 and less than or equal to (pageDimensions.width - contentBox.x). |
| contentBox.height | Greater than or equal to 0.0 and less than or equal to (pageDimensions.height - contentBox.y). |
| contentBox.x | Greater than or equal to 0.0 and less than pageDimensions.width. |
| contentBox.y | Greater 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 code | Description |
|---|---|
|
The method succeeded. |
|
contentBox is NULL. |
|
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
| 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 |