IIXC_Page::Rect Property

From Tracker Software PDF SDK
Jump to: navigation, search
Line 4: Line 4:
  
  
Fill ''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]].
+
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]].
 
+
Many [[PXV:IIXC_Page|IIXC_Page]] object methods have a ''pRect'' 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 there.
+
  
 
== Syntax ==
 
== Syntax ==
 
<pre class="brush:cpp;gutter:false">HRESULT get_Rect([out, retval]  RECT*  pRect);
 
<pre class="brush:cpp;gutter:false">HRESULT get_Rect([out, retval]  RECT*  pRect);
 
</pre>
 
</pre>
 +
 +
== Remarks ==
 +
Many [[PXV:IIXC_Page|IIXC_Page]] object methods have a ''pRect'' 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 there.
  
 
== See Also ==
 
== See Also ==
 
See also [[PXV:IIXC_Page|IIXC_Page]].
 
See also [[PXV:IIXC_Page|IIXC_Page]].

Revision as of 10:53, 18 May 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*  pRect);

Remarks

Many IIXC_Page object methods have a pRect 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 there.

See Also

See also IIXC_Page.