IUIX_InfoBtn::GetIdealSize Method

Latest revision as of 16:22, 15 June 2015

UI Layer > Interfaces > IUIX_InfoBtn > IUIX_InfoBtn::GetIdealSize Method

Calculates info button ideal size that will fit value, given in nAvailSize variable.

HRESULT GetIdealSize([in]           SIZE*  nAvailSize,
                     [out, retval]  SIZE*  nIdealSize);

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.

Returns S_OK if the operation was successful, or will return an error code if it fails.

@@ Line 1: / Line 1: @@
+__NOTOC__
 [[Category:Editor]]
 {{#customTitle:IUIX_InfoBtn::GetIdealSize Method}}
-{{#parentPage:PXV:IUIX_InfoBtn|GetIdealSize Method|method}}
+{{#parentPage:PXV:IUIX_InfoBtn#Methods|GetIdealSize|method}}
-{{ToWrite}}
-{{ToReview}}
-The method of interface of PDF-XChange Editor SDK.
+Calculates [[PXV:IUIX_InfoBtn|info button]] ''ideal size'' that will fit value, given in '''nAvailSize''' variable.
 == Syntax ==
-<pre class="brush:cpp;gutter:false">HRESULT GetIdealSize([in]           SIZE*  pAvailSize,
+<pre class="brush:cpp;gutter:false">HRESULT GetIdealSize([in]           SIZE*  nAvailSize,
-                      [out, retval]  SIZE*  pIdealSize);</pre>
+                      [out, retval]  SIZE*  nIdealSize);</pre>
 == Parameters ==
-;pAvailSize
+;nAvailSize
-:[in]  Pointer to SIZE.
+:[in]  value of available size, based on which an ideal info button size will be calculated.
-;pIdealSize
+;nIdealSize
-:[out, retval]  Pointer to SIZE.
+:[out, retval]  value of ideal info button size, calculated to fit the value of ''nAvailSize''.
 == Return Value ==
-Returns S_OK if operation was successful or error code in other cases.
+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]].
+[[PXV:IUIX_InfoBtn|IUIX_InfoBtn]]