IIXC_Page::AlphaPlace Method
From PDF XChange PDF SDK
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 AlphaPlace([in] IIXC_Page* | + | <pre class="brush:cpp;gutter:false">HRESULT AlphaPlace([in] IIXC_Page* srcFrom, |
− | [in] LONG | + | [in] LONG SX, |
− | [in] LONG | + | [in] LONG SY, |
− | [in] UCHAR | + | [in] UCHAR Alpha, |
− | [in] ULONG | + | [in] ULONG Flags, |
− | [in] RECT* | + | [in] RECT* Rect);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;srcFrom |
:[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. | ||
− | ; | + | ;SX |
:[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle. | :[in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle. | ||
− | ; | + | ;SY |
:[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle. | :[in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle. | ||
− | ; | + | ;Alpha |
:[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]]. | :[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]]. | ||
− | ; | + | ;Flags |
:[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]]. | :[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]]. | ||
− | ; | + | ;Rect |
:[in] Pointer to the RECT structure which defines the destination rectangle. | :[in] Pointer to the RECT structure which defines the destination rectangle. | ||
Revision as of 05:50, 12 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* srcFrom, [in] LONG SX, [in] LONG SY, [in] UCHAR Alpha, [in] ULONG Flags, [in] RECT* Rect);
Parameters
- srcFrom
- [in] Pointer to IIXC_Page of the source page from which the area is to be copied.
- SX
- [in] Specifies the x-coordinate, in pixels, of the upper-left corner of the source rectangle.
- SY
- [in] Specifies the y-coordinate, in pixels, of the upper-left corner of the source rectangle.
- Alpha
- [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.
- Flags
- [in] Combination of flags which specifies how the data will be copied. For more details about this parameter, see enum IXC_ColorFlags.
- Rect
- [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.