IIXC_Page::ToGrayScale Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
 
{{#parentPage:PXV:IIXC_Page|ToGrayScale Method|method}}
 
{{#parentPage:PXV:IIXC_Page|ToGrayScale Method|method}}
{{ToWrite}}
+
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
The method converts the image to grayscale.
 +
 
 +
{{note|Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.}}
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pRect
 
;pRect
:[in]  Pointer to RECT.
+
:[in]  Pointer to the RECT structure which defines the rectangular area where colors should be grayscaled. If this parameter is NULL, the entire page will be grayscaled.
 +
{{note|Please note that processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because each pixel in such images contains not the color, but the index into color table (palette) which is common for the entire page}}
  
 
== Return Value ==
 
== Return Value ==
Line 18: Line 21:
  
 
== See Also ==
 
== See Also ==
See also [[PXV:IIXC_Page|IIXC_Page]].
+
:[[PXV:IIXC_Page|IIXC_Page]]
 +
:[[PXV:IIXC_Page_ConvertToFormat|IIXC_Page::ConvertToFormat]]

Revision as of 05:39, 30 April 2015


The method converts the image to grayscale.

Note:
Please note that this function doesn't change the internal page format to PageFormat_8Gray, or PageFormat_8AlphaGray.

Syntax

HRESULT ToGrayScale([in]  RECT*  pRect);

Parameters

pRect
[in] Pointer to the RECT structure which defines the rectangular area where colors should be grayscaled. If this parameter is NULL, the entire page will be grayscaled.
Note:
Please note that processing of part of the page is not supported for some internal formats. For example, it is not supported for indexed images, because each pixel in such images contains not the color, but the index into color table (palette) which is common for the entire page

Return Value

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

See Also

IIXC_Page
IIXC_Page::ConvertToFormat