IIXC_Page::ReplaceColor Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
m (Automatic page editing by robot)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::ReplaceColor Method}}
 
{{#customTitle:IIXC_Page::ReplaceColor Method}}
{{#parentPage:PXV:IIXC_Page|ReplaceColor Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|ReplaceColor|method}}
{{ToWrite}}
+
{{ToReview}}
+
  
The method of interface of PDF-XChange Editor SDK.
+
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  nFromColor,
                     [in]                      ULONG  toColor,
+
                     [in]                      ULONG  nToColor,
 
                                               ULONG  nFlags,
 
                                               ULONG  nFlags,
                     [in, defaultvalue(NULL)]  RECT*  pRect);</pre>
+
                     [in, defaultvalue(NULL)]  RECT*  stRect);</pre>
  
 
== Parameters ==
 
== Parameters ==
;fromColor
+
;nFromColor
:[in]  Value of ULONG.
+
:[in]  Specifies the color to be replaced.
;toColor
+
;nToColor
:[in]  Value of ULONG.
+
:[in]  Specifies replacement color.
 
;nFlags
 
;nFlags
: Value of ULONG.
+
: Combination of [[PXV:IXC_ColorFlags|IXC_ColorFlags]] which specifies how the data will be copied.
;pRect
+
;stRect
:[in, defaultvalue(NULL)]  Pointer to RECT.
+
:[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 ==
Line 27: Line 26:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
[[PXV:IIXC_Page|IIXC_Page]]

Latest revision as of 03:16, 15 June 2015

The ReplaceColor method replaces one color with another in the page or rectangular area.

Syntax

HRESULT ReplaceColor([in]                      ULONG  nFromColor,
                     [in]                      ULONG  nToColor,
                                               ULONG  nFlags,
                     [in, defaultvalue(NULL)]  RECT*  stRect);

Parameters

nFromColor
[in] Specifies the color to be replaced.
nToColor
[in] Specifies replacement color.
nFlags
Combination of IXC_ColorFlags which specifies how the data will be copied.
stRect
[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.

See Also

IIXC_Page