IIXC_Page::Tile Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
Line 7: Line 7:
  
 
== Syntax ==
 
== Syntax ==
<pre class="brush:cpp;gutter:false">HRESULT Tile([in]  RECT*      destRect,
+
<pre class="brush:cpp;gutter:false">HRESULT Tile([in]  RECT*      stDestRect,
             [in]  IIXC_Page*  srcPage,
+
             [in]  IIXC_Page*  pSrcPage,
             [in]  RECT*      srcRect,
+
             [in]  RECT*      stSrcRect,
             [in]  LONG        originX,
+
             [in]  LONG        nOriginX,
             [in]  LONG        originY,
+
             [in]  LONG        nOriginY,
 
             [in]  ULONG      nFlags);</pre>
 
             [in]  ULONG      nFlags);</pre>
  
 
== Parameters ==
 
== Parameters ==
;destRect
+
;stDestRect
:[in]  Pointer to a ''RECT'' structure which defines the destination rectangle on the target page which will be filled from the '''srcPage''' page.
+
:[in]  Pointer to a ''RECT'' structure which defines the destination rectangle on the target page which will be filled from the '''pSrcPage''' page.
;srcPage
+
;pSrcPage
 
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied.
 
:[in]  Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied.
;srcRect
+
;stSrcRect
:[in]  Pointer to a ''RECT'' structure which defines the rectangle from the '''srcPage''' page which should be tiled onto the target page.
+
:[in]  Pointer to a ''RECT'' structure which defines the rectangle from the '''pSrcPage''' page which should be tiled onto the target page.
;originX
+
;nOriginX
 
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
;originY
+
;nOriginY
 
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
;nFlags
 
;nFlags

Revision as of 01:08, 4 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.

See Also

IIXC_Page