IIXC_Page::Rect Property
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
(13 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IIXC_Page::Rect Property}} | {{#customTitle:IIXC_Page::Rect Property}} | ||
− | {{#parentPage:PXV:IIXC_Page|property | + | {{#parentPage:PXV:IIXC_Page#Properties|Rect|property}} |
− | + | ||
− | + | ||
− | + | Fills the ''RECT'' structure with page dimensions, ie, '''left''' and '''top''' fields will be set to zero, '''right''' - to the [[PXV:IIXC_Page_Width|page width]], and '''bottom''' to the [[PXV:IIXC_Page_Height|page height]]. | |
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT get_Rect([out, retval] RECT* | + | <pre class="brush:cpp;gutter:false">HRESULT get_Rect([out, retval] RECT* stRect); |
</pre> | </pre> | ||
+ | |||
+ | == Remarks == | ||
+ | Many [[PXV:IIXC_Page|IIXC_Page]] object methods have a ''stRect'' parameter that specifies a portion of the page to be processed. When this parameter is <tt>NULL</tt>, the entire page is processed. Some languages, like C#, cannot easily pass <tt>NULL</tt> and they need to pass a valid ''RECT'' that covers entire page, and this property may be very helpful then. | ||
== See Also == | == See Also == | ||
− | + | [[PXV:IIXC_Page|IIXC_Page]] |
Latest revision as of 02:17, 15 June 2015
Fills the RECT structure with page dimensions, ie, left and top fields will be set to zero, right - to the page width, and bottom to the page height.
Syntax
HRESULT get_Rect([out, retval] RECT* stRect);
Remarks
Many IIXC_Page object methods have a stRect parameter that specifies a portion of the page to be processed. When this parameter is NULL, the entire page is processed. Some languages, like C#, cannot easily pass NULL and they need to pass a valid RECT that covers entire page, and this property may be very helpful then.