IIXC_Page::Crop Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (11 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::Crop Method}} | {{#customTitle:IIXC_Page::Crop Method}} | ||
| − | {{#parentPage:PXV:IIXC_Page|Crop | + | {{#parentPage:PXV:IIXC_Page#Methods|Crop|method}} |
| − | + | The '''Crop''' method crops the specified page to the specified rectangular area. | |
| − | + | ||
| − | The method crops the specified page to the specified rectangular area. | + | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT Crop([in] RECT* | + | <pre class="brush:cpp;gutter:false">HRESULT Crop([in] RECT* stRect);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;stRect |
| − | :[in] Pointer to RECT structure which defines the rectangular cropping area. | + | :[in] Pointer to RECT structure which defines the rectangular cropping area. If this parameter is <tt>NULL</tt> the function will do nothing. If it specifies an empty rectangle, or an rectangle that has no intersection with [[PXV:IIXC_Page_Rect|page's rectangle]], function will fail. |
== Return Value == | == Return Value == | ||
| Line 18: | Line 17: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IIXC_Page|IIXC_Page]] | |
Latest revision as of 02:16, 15 June 2015
The Crop method crops the specified page to the specified rectangular area.
Syntax
HRESULT Crop([in] RECT* stRect);
Parameters
- stRect
- [in] Pointer to RECT structure which defines the rectangular cropping area. If this parameter is NULL the function will do nothing. If it specifies an empty rectangle, or an rectangle that has no intersection with page's rectangle, function will fail.
Return Value
Returns S_OK if operation was successful or error code in other cases.
