IIXC_Page::AlphaPlace Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(16 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::AlphaPlace Method}} | {{#customTitle:IIXC_Page::AlphaPlace Method}} | ||
+ | {{#parentPage:PXV:IIXC_Page#Methods|AlphaPlace|method}} | ||
− | The method of | + | The '''AlphaPlace''' method copies a specified rectangular area from one page into another using a specified level of transparency. If the alpha parameter is 255, this function is equal to function [[PXV:IIXC_Page_Place|IIXC_Page::Place]]. |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT AlphaPlace([in] | + | <pre class="brush:cpp;gutter:false">HRESULT AlphaPlace([in] IIXC_Page* pSrcFrom, |
+ | [in] LONG nSX, | ||
+ | [in] LONG nSY, | ||
+ | [in] UCHAR nAlpha, | ||
+ | [in] ULONG nFlags, | ||
+ | [in] RECT* stRect);</pre> | ||
== Parameters == | == Parameters == | ||
− | ; | + | ;pSrcFrom |
− | + | :[in] Pointer to [[PXV:IIXC_Page|IIXC_Page]] of the source page from which the area is to be copied. | |
− | + | ;nSX | |
− | :[in] Pointer to [[PXV:IIXC_Page|IIXC_Page]]. | + | :[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle. |
− | ; | + | ;nSY |
− | :[in] | + | :[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle. |
− | ; | + | ;nAlpha |
− | :[in] | + | :[in] Specifies the transparency level. Range of values is from 0 to 255. Value 0 means that srcPage is fully transparent, value 255 means that srcPage is fully opaque. If the alpha parameter is 255, this function is equal to function [[PXV:IIXC_Page_Place|IIXC_Page::Place]]. |
− | ; | + | ;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]]. |
− | ; | + | ;stRect |
− | :[in] | + | :[in] Pointer to the RECT structure which defines the destination rectangle. |
== Return Value == | == Return Value == | ||
Line 25: | Line 32: | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IIXC_Page|IIXC_Page]] |
Latest revision as of 02:16, 15 June 2015
The AlphaPlace method copies a specified rectangular area from one page into another using a specified level of transparency. If the alpha parameter is 255, this function is equal to function IIXC_Page::Place.
Syntax
HRESULT AlphaPlace([in] IIXC_Page* pSrcFrom, [in] LONG nSX, [in] LONG nSY, [in] UCHAR nAlpha, [in] ULONG nFlags, [in] RECT* stRect);
Parameters
- pSrcFrom
- [in] Pointer to IIXC_Page of the source page from which the area is to be copied.
- nSX
- [in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle.
- nSY
- [in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle.
- nAlpha
- [in] Specifies the transparency level. Range of values is from 0 to 255. Value 0 means that srcPage is fully transparent, value 255 means that srcPage is fully opaque. If the alpha parameter is 255, this function is equal to function IIXC_Page::Place.
- nFlags
- [in] Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum IXC_ColorFlags.
- stRect
- [in] Pointer to the RECT structure which defines the destination rectangle.
Return Value
Returns S_OK if operation was successful or error code in other cases.