IIXC_Page::ToGrayScale Method

From Tracker Software PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
__NOTOC__
 
[[Category:Editor]]
 
[[Category:Editor]]
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
 
{{#customTitle:IIXC_Page::ToGrayScale Method}}
{{#parentPage:PXV:IIXC_Page|ToGrayScale Method|method}}
+
{{#parentPage:PXV:IIXC_Page#Methods|ToGrayScale|method}}
 +
{{ToReview}}
  
 
+
Change colors to grayscale in the specified rectangle area.
The '''ToGrayScale''' 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 ==
<pre class="brush:cpp;gutter:false">HRESULT ToGrayScale([in]  RECT*  pRect);</pre>
+
<pre class="brush:cpp;gutter:false">HRESULT ToGrayScale([in]  RECT*  stRect);</pre>
  
 
== Parameters ==
 
== Parameters ==
;pRect
+
;stRect
 
:[in]  Pointer to a ''RECT'' structure which defines the rectangular area where colors should be grayscaled. If this parameter is <tt>NULL</tt>, the entire page will be grayscaled.
 
:[in]  Pointer to a ''RECT'' structure which defines the rectangular area where colors should be grayscaled. If this parameter is <tt>NULL</tt>, 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 the pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page}}
 
{{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 the pixels in such images do not contain a color, but an index into a color table (or palette) which is common for the entire page}}
Line 20: Line 19:
  
 
== See Also ==
 
== See Also ==
:[[PXV:IIXC_Page|IIXC_Page]]
+
[[PXV:IIXC_Page|IIXC_Page]]
:[[PXV:IIXC_Page_ConvertToFormat|IIXC_Page::ConvertToFormat]]
+

Latest revision as of 02:17, 15 June 2015


Change colors to grayscale in the specified rectangle area.

Syntax

HRESULT ToGrayScale([in]  RECT*  stRect);

Parameters

stRect
[in] Pointer to a 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 the pixels in such images do not contain a color, but an index into a color table (or 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