IUIX_InfoBtn::GetIdealSize Method
From PDF XChange PDF SDK
(7 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
+ | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_InfoBtn::GetIdealSize Method}} | {{#customTitle:IUIX_InfoBtn::GetIdealSize Method}} | ||
− | {{#parentPage:PXV:IUIX_InfoBtn|GetIdealSize | + | {{#parentPage:PXV:IUIX_InfoBtn#Methods|GetIdealSize|method}} |
− | + | ||
− | Calculates [[PXV:IUIX_InfoBtn|info button]] ideal size that will fit value, given in ''' | + | |
+ | Calculates [[PXV:IUIX_InfoBtn|info button]] ''ideal size'' that will fit value, given in '''nAvailSize''' variable. | ||
== Syntax == | == Syntax == | ||
− | <pre class="brush:cpp;gutter:false">HRESULT GetIdealSize([in] SIZE* | + | <pre class="brush:cpp;gutter:false">HRESULT GetIdealSize([in] SIZE* nAvailSize, |
− | [out, retval] SIZE* | + | [out, retval] SIZE* nIdealSize);</pre> |
== Parameters == | == Parameters == | ||
− | ; | + | ;nAvailSize |
:[in] value of available size, based on which an ideal info button size will be calculated. | :[in] value of available size, based on which an ideal info button size will be calculated. | ||
− | ; | + | ;nIdealSize |
− | :[out, retval] value of ideal info button size, calculated to fit the value of '' | + | :[out, retval] value of ideal info button size, calculated to fit the value of ''nAvailSize''. |
== 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_InfoBtn|IUIX_InfoBtn]] |
Latest revision as of 16:22, 15 June 2015
Calculates info button ideal size that will fit value, given in nAvailSize variable.
Syntax
HRESULT GetIdealSize([in] SIZE* nAvailSize, [out, retval] SIZE* nIdealSize);
Parameters
- nAvailSize
- [in] value of available size, based on which an ideal info button size will be calculated.
- nIdealSize
- [out, retval] value of ideal info button size, calculated to fit the value of nAvailSize.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.