IIXC_Page::ReplaceColor Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::ReplaceColor Method}}
 
{{#customTitle:IIXC_Page::ReplaceColor Method}}
 
{{#parentPage:PXV:IIXC_Page|ReplaceColor Method|method}}
 
{{#parentPage:PXV:IIXC_Page|ReplaceColor Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method replaces one color with another on the page.
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 15:
 
== Parameters ==
 
== Parameters ==
 
;fromColor
 
;fromColor
:[in]  Value of ULONG.
+
:[in]  Specifies the color to be replaced.
 
;toColor
 
;toColor
:[in]  Value of ULONG.
+
:[in]  Specifies replacement color.
 
;nFlags
 
;nFlags
: Value of ULONG.
+
: Combination of flags which specifies how the data will be copied. The following flags can be used enum [[PXV:IXC_ColorFlags|IXC_ColorFlags]]
 
;pRect
 
;pRect
:[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.
  
 
== Return Value ==
 
== Return Value ==
Line 27: Line 27:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IXC_ColorFlags|IXC_ColorFlags]]

Revision as of 01:19, 6 May 2015


The method replaces one color with another on the page.

Syntax

HRESULT ReplaceColor([in]                      ULONG  fromColor,
                     [in]                      ULONG  toColor,
                                               ULONG  nFlags,
                     [in, defaultvalue(NULL)]  RECT*  pRect);

Parameters

fromColor
[in] Specifies the color to be replaced.
toColor
[in] Specifies replacement color.
nFlags
Combination of flags which specifies how the data will be copied. The following flags can be used enum IXC_ColorFlags
pRect
[in, defaultvalue(NULL)] Pointer to RECT structure which defines the rectangular area in which the operation will be performed.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

IIXC_Page
IXC_ColorFlags