IUIX_Dialog::GetItemsBoundRect Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
(2 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_Dialog::GetItemsBoundRect Method}} | {{#customTitle:IUIX_Dialog::GetItemsBoundRect Method}} | ||
− | {{#parentPage:PXV:IUIX_Dialog#Methods|GetItemsBoundRect | + | {{#parentPage:PXV:IUIX_Dialog#Methods|GetItemsBoundRect|method}} |
− | + | ||
Returns the smallest rectangle that contains all dialog items. | Returns the smallest rectangle that contains all dialog items. | ||
Line 9: | Line 9: | ||
== Syntax == | == Syntax == | ||
<pre class="brush:cpp;gutter:false">HRESULT GetItemsBoundRect([in, defaultvalue(-1)] VARIANT_BOOL bSkipHidden, | <pre class="brush:cpp;gutter:false">HRESULT GetItemsBoundRect([in, defaultvalue(-1)] VARIANT_BOOL bSkipHidden, | ||
− | [out, retval] RECT* | + | [out, retval] RECT* stBoundRect);</pre> |
== Parameters == | == Parameters == | ||
;bSkipHidden | ;bSkipHidden | ||
:[in, defaultvalue(-1)] if set to <code>VARIANT_TRUE</code>, hidden items will not be counted when calculating bounding rectangle. | :[in, defaultvalue(-1)] if set to <code>VARIANT_TRUE</code>, hidden items will not be counted when calculating bounding rectangle. | ||
− | ; | + | ;stBoundRect |
:[out, retval] result <code>RECT</code> value in dialog coordinate system. | :[out, retval] result <code>RECT</code> value in dialog coordinate system. | ||
== Return Value == | == Return Value == | ||
− | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
[[PXV:IUIX_Dialog|IUIX_Dialog]] | [[PXV:IUIX_Dialog|IUIX_Dialog]] |
Latest revision as of 14:15, 15 June 2015
Returns the smallest rectangle that contains all dialog items.
Syntax
HRESULT GetItemsBoundRect([in, defaultvalue(-1)] VARIANT_BOOL bSkipHidden, [out, retval] RECT* stBoundRect);
Parameters
- bSkipHidden
- [in, defaultvalue(-1)] if set to
VARIANT_TRUE
, hidden items will not be counted when calculating bounding rectangle. - stBoundRect
- [out, retval] result
RECT
value in dialog coordinate system.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.