IXpsOMPackageWriter::AddPage 方法 (xpsobjectmodel.h)
将新的 FixedPage 部件写入包中当前打开的 FixedDocument 部件。
语法
HRESULT AddPage(
[in] IXpsOMPage *page,
[in] const XPS_SIZE *advisoryPageDimensions,
[in] IXpsOMPartUriCollection *discardableResourceParts,
[in] IXpsOMStoryFragmentsResource *storyFragments,
[in] IXpsOMPrintTicketResource *pagePrintTicket,
[in] IXpsOMImageResource *pageThumbnail
);
参数
[in] page
IXpsOMPage 接口,其页面内容将写入包的当前打开的 FixedDocument。
[in] advisoryPageDimensions
包含页面维度 的XPS_SIZE 结构。
大小以 XPS 单元描述。 每英寸有 96 个 XPS 单位。 例如,8.5“ x 11.0” 页的维度为 816 x 1,056 XPS 单位。
[in] discardableResourceParts
包含可丢弃资源部件集合的 IXpsOMPartUriCollection 接口。
[in] storyFragments
要用于此页面的 IXpsOMStoryFragmentsResource 接口。
[in] pagePrintTicket
IXpsOMPrintTicketResource 接口,其中包含此页面的页面级打印票证。 请参见备注。
[in] pageThumbnail
包含此页面缩略图的 IXpsOMImageResource 接口。
返回值
该方法返回 HRESULT。 可能的值包括但不限于后面的表中的值。 有关此表中未列出的 XPS 文档 API 返回值的信息,请参阅 XPS 文档错误。
返回代码 | 说明 |
---|---|
|
方法成功。 |
|
页面引用可丢弃的资源,但不指定 DiscardControl 部件名称。 |
|
在 StartNewDocument 之前调用了此方法。 |
|
发生严重错误,并且 XPS OM 的内容可能无法恢复。 XPS OM 的某些组件可能仍可用,但仅在验证后才可用。 由于在返回此错误后无法预测 XPS OM 的状态,因此应释放并丢弃 XPS OM 的所有组件。 |
此方法调用 打包 API。 有关打包 API 返回值的信息,请参阅 打包错误。
注解
调用 StartNewDocument 后调用此方法。
此方法在包中创建一个新的 FixedPage 部件,复制在 page 参数中传递的 IXpsOMPage 接口的内容,然后在页面写入包后关闭新的 FixedPage 部件。
如果 pagePrintTicket 包含 NULL 指针,并且包编写器是使用交错设置为 XPS_INTERLEAVING_ON 创建的,则此方法将创建一个空白页面级打印票证(如果尚不存在)。 每次使用 pagePrintTicket 中的 NULL 指针调用方法时,都会将新页面的关系添加到空白打印票证。 这样做是为了更高效地使用包。
如果 pagePrintTicket 包含 NULL 指针,并且包编写器是使用交错设置为 XPS_INTERLEAVING_OFF 创建的,则不会创建空白打印票证。
要求
要求 | 值 |
---|---|
最低受支持的客户端 | Windows 7、带 SP2 的 Windows Vista 和适用于 Windows Vista 的平台更新 [桌面应用 |UWP 应用] |
最低受支持的服务器 | Windows Server 2008 R2、Windows Server 2008 SP2 和适用于 Windows Server 2008 的平台更新 [桌面应用 |UWP 应用] |
目标平台 | Windows |
标头 | xpsobjectmodel.h |