IIXC_Page::Tile Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::Tile Method}} | {{#customTitle:IIXC_Page::Tile Method}} | ||
| + | {{#parentPage:PXV:IIXC_Page#Methods|Tile|method}} | ||
| − | + | '''Tile''' fills a rectangular area on the destination page from another source page by "tiling" the source area into the destination area. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Tile([in] RECT* | + | <pre class="brush:cpp;gutter:false">HRESULT Tile([in] RECT* stDestRect, |
| + | [in] IIXC_Page* pSrcPage, | ||
| + | [in] RECT* stSrcRect, | ||
| + | [in] LONG nOriginX, | ||
| + | [in] LONG nOriginY, | ||
| + | [in] ULONG nFlags);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;stDestRect |
| − | :[in] Pointer to RECT | + | :[in] Pointer to a ''RECT'' structure which defines the destination rectangle on the target page which will be filled from the '''pSrcPage''' page. |
| − | + | ;pSrcPage | |
| − | :[in] Pointer to [[PXV:IIXC_Page|IIXC_Page]]. | + | :[in] Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied. |
| − | ; | + | ;stSrcRect |
| − | :[in] Pointer to RECT | + | :[in] Pointer to a ''RECT'' structure which defines the rectangle from the '''pSrcPage''' page which should be tiled onto the target page. |
| − | + | ;nOriginX | |
| − | :[in] | + | :[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling. |
| − | ; | + | ;nOriginY |
| − | :[in] | + | :[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling. |
| − | ; | + | ;nFlags |
| − | :[in] | + | :[in] Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum [[PXV:IXC_ColorFlags|IXC_ColorFlags]]. |
== Return Value == | == Return Value == | ||
Returns S_OK if operation was successful or error code in other cases. | Returns S_OK if operation was successful or error code in other cases. | ||
| + | |||
| + | == Remarks == | ||
| + | "Tiling" consists of copying the same source rectangle over and over into the destination area filling it both horizontally and vertically. | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
Latest revision as of 02:17, 15 June 2015
Tile fills a rectangular area on the destination page from another source page by "tiling" the source area into the destination area.
Syntax
HRESULT Tile([in] RECT* stDestRect,
[in] IIXC_Page* pSrcPage,
[in] RECT* stSrcRect,
[in] LONG nOriginX,
[in] LONG nOriginY,
[in] ULONG nFlags);
Parameters
- stDestRect
- [in] Pointer to a RECT structure which defines the destination rectangle on the target page which will be filled from the pSrcPage page.
- pSrcPage
- [in] Pointer to IIXC_Page of the source page from which the area is to be copied.
- stSrcRect
- [in] Pointer to a RECT structure which defines the rectangle from the pSrcPage page which should be tiled onto the target page.
- nOriginX
- [in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
- nOriginY
- [in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
- nFlags
- [in] Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum IXC_ColorFlags.
Return Value
Returns S_OK if operation was successful or error code in other cases.
Remarks
"Tiling" consists of copying the same source rectangle over and over into the destination area filling it both horizontally and vertically.
