IIXC_Page::ToGrayScale Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (11 intermediate revisions by 3 users 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|method | + | {{#parentPage:PXV:IIXC_Page#Methods|ToGrayScale|method}} |
| − | + | ||
{{ToReview}} | {{ToReview}} | ||
| − | + | Change colors to grayscale in the specified rectangle area. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT ToGrayScale([in] RECT* | + | <pre class="brush:cpp;gutter:false">HRESULT ToGrayScale([in] RECT* stRect);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;stRect |
| − | :[in] Pointer to RECT. | + | :[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}} | ||
== Return Value == | == Return Value == | ||
| Line 18: | Line 19: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
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 pageReturn Value
Returns S_OK if operation was successful or error code in other cases.
