IIXC_Page::ReplaceColor Method
From PDF XChange PDF SDK
Line 3: | Line 3: | ||
{{#parentPage:PXV:IIXC_Page|ReplaceColor Method|method}} | {{#parentPage:PXV:IIXC_Page|ReplaceColor Method|method}} | ||
− | |||
− | The method replaces one color with another | + | The '''ReplaceColor''' method replaces one color with another in the page or rectangular area. |
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT ReplaceColor([in] ULONG fromColor, | <pre class="brush:cpp;gutter:false">HRESULT ReplaceColor([in] ULONG fromColor, | ||
[in] ULONG toColor, | [in] ULONG toColor, | ||
− | + | [in] ULONG nFlags, | |
[in, defaultvalue(NULL)] RECT* pRect);</pre> | [in, defaultvalue(NULL)] RECT* pRect);</pre> | ||
Line 19: | Line 18: | ||
:[in] Specifies replacement color. | :[in] Specifies replacement color. | ||
;nFlags | ;nFlags | ||
− | : Combination of | + | : Combination of [[PXV:IXC_ColorFlags|IXC_ColorFlags]] which specifies how the data will be copied. |
;pRect | ;pRect | ||
− | :[in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area in which the operation will be performed. | + | :[in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area in which the operation will be performed. If set to <tt>NULL</tt> then the entire page will be changed. |
== Return Value == | == Return Value == |
Revision as of 11:24, 18 May 2015
The ReplaceColor method replaces one color with another in the page or rectangular area.
Contents
Syntax
HRESULT ReplaceColor([in] ULONG fromColor, [in] ULONG toColor, [in] ULONG nFlags, [in, defaultvalue(NULL)] RECT* pRect);
Parameters
- fromColor
- [in] Specifies the color to be replaced.
- toColor
- [in] Specifies replacement color.
- nFlags
- Combination of IXC_ColorFlags which specifies how the data will be copied.
- pRect
- [in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area in which the operation will be performed. If set to NULL then the entire page will be changed.
Return Value
Returns S_OK if operation was successful or error code in other cases.