IIXC_Page::Tile Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::Tile Method}}
 
{{#customTitle:IIXC_Page::Tile Method}}
 
{{#parentPage:PXV:IIXC_Page|Tile Method|method}}
 
{{#parentPage:PXV:IIXC_Page|Tile Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
'''Tile''' fills a rectangular area on the destination page from another source page by "tiling" the source area into the destination area.
  
 
== Syntax ==
 
== Syntax ==
Line 17: Line 17:
 
== Parameters ==
 
== Parameters ==
 
;destRect
 
;destRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the destination rectangle on the destPage page which will be filled from srcPage page.
 
;srcPage
 
;srcPage
:[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.
 
;srcRect
 
;srcRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to RECT structure which defines the rectangle into '''srcPage''' page which should be tiled onto page.
 
;originX
 
;originX
:[in]  Value of LONG.
+
:[in]  Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
;originY
 
;originY
:[in]  Value of LONG.
+
:[in]  Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
 
;nFlags
 
;nFlags
:[in]  Value of ULONG.
+
:[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 ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_Place|IIXC_Page::Place]]
 +
:[[PXV:IIXC_Page_AlphaPlace|IIXC_Page::AlphaPlace]]
 +
:[[PXV:IIXC_Page_AlphaTile|IIXC_Page::AlphaTile]]
 +
:[[PXV:IXC_ColorFlags|IXC_ColorFlags]]

Revision as of 22:53, 28 April 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*       destRect,
             [in]  IIXC_Page*  srcPage,
             [in]  RECT*       srcRect,
             [in]  LONG        originX,
             [in]  LONG        originY,
             [in]  ULONG       nFlags);

Parameters

destRect
[in] Pointer to RECT structure which defines the destination rectangle on the destPage page which will be filled from srcPage page.
srcPage
[in] Pointer to IIXC_Page of the source page from which the area is to be copied.
srcRect
[in] Pointer to RECT structure which defines the rectangle into srcPage page which should be tiled onto page.
originX
[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle which will be used for tiling.
originY
[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
IIXC_Page::Place
IIXC_Page::AlphaPlace
IIXC_Page::AlphaTile
IXC_ColorFlags