IUIX_CmdBar::InsertNewBox Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 3: | Line 3: | ||
{{#customTitle:IUIX_CmdBar::InsertNewBox Method}} | {{#customTitle:IUIX_CmdBar::InsertNewBox Method}} | ||
{{#parentPage:PXV:IUIX_CmdBar#Methods|InsertNewBox|method}} | {{#parentPage:PXV:IUIX_CmdBar#Methods|InsertNewBox|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts new [[PXV:IUIX_CmdItemBox|command items box]] into the command bar. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertNewBox([in] | + | <pre class="brush:cpp;gutter:false">HRESULT InsertNewBox([in] BSTR pNewBoxID, |
| − | [in, defaultvalue(-1)] | + | [in, defaultvalue(-1)] LONG nInsertBefore, |
| − | [in, defaultvalue( | + | [in, defaultvalue(UIX_CmdItemSize_Large)] UIX_CmdItemSize nIdealSize, |
| − | [in, defaultvalue( | + | [in, defaultvalue(UIX_CmdItemSize_Small)] UIX_CmdItemSize nLowerSize, |
| − | [in, defaultvalue(0)] | + | [in, defaultvalue(0)] LONG nStyle, |
| − | [out, retval, defaultvalue(NULL)] | + | [out, retval, defaultvalue(NULL)] IUIX_CmdItemBox** pItemBox);</pre> |
== Parameters == | == Parameters == | ||
;pNewBoxID | ;pNewBoxID | ||
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the new command item box'es ID. |
;nInsertBefore | ;nInsertBefore | ||
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the insert index. |
;nIdealSize | ;nIdealSize | ||
| − | :[in, defaultvalue(UIX_CmdItemSize_Default)] Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]]. | + | :[in, defaultvalue(UIX_CmdItemSize_Default)] Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]] containing the optimal size of the command items in the command items box. |
;nLowerSize | ;nLowerSize | ||
| − | :[in, defaultvalue(UIX_CmdItemSize_Default)] Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]]. | + | :[in, defaultvalue(UIX_CmdItemSize_Default)] Value of [[PXV:UIX_CmdItemSize|UIX_CmdItemSize]] containing the smallest size of the command items in the command items box. |
;nStyle | ;nStyle | ||
| − | :[in, defaultvalue(0)] Value of LONG. | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemBoxStyleFlags|command items box'es style]]. |
;pItemBox | ;pItemBox | ||
| − | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]]. | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] containing the newly inserted command box. |
== Return Value == | == Return Value == | ||
Latest revision as of 07:59, 30 November 2017
Inserts new command items box into the command bar.
Syntax
HRESULT InsertNewBox([in] BSTR pNewBoxID,
[in, defaultvalue(-1)] LONG nInsertBefore,
[in, defaultvalue(UIX_CmdItemSize_Large)] UIX_CmdItemSize nIdealSize,
[in, defaultvalue(UIX_CmdItemSize_Small)] UIX_CmdItemSize nLowerSize,
[in, defaultvalue(0)] LONG nStyle,
[out, retval, defaultvalue(NULL)] IUIX_CmdItemBox** pItemBox);
Parameters
- pNewBoxID
- [in] Value of BSTR containing the new command item box'es ID.
- nInsertBefore
- [in, defaultvalue(-1)] Value of LONG containing the insert index.
- nIdealSize
- [in, defaultvalue(UIX_CmdItemSize_Default)] Value of UIX_CmdItemSize containing the optimal size of the command items in the command items box.
- nLowerSize
- [in, defaultvalue(UIX_CmdItemSize_Default)] Value of UIX_CmdItemSize containing the smallest size of the command items in the command items box.
- nStyle
- [in, defaultvalue(0)] Value of LONG containing the command items box'es style.
- pItemBox
- [out, retval, defaultvalue(NULL)] Pointer to IUIX_CmdItemBox containing the newly inserted command box.
Return Value
Returns S_OK if operation was successful or error code in other cases.
