IUIX_CmdBar::InsertNewBox Method
From PDF XChange PDF SDK
(Automatic page editing by robot) |
m (Automatic page editing by robot) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdBar::InsertNewBox Method}} | {{#customTitle:IUIX_CmdBar::InsertNewBox Method}} | ||
| + | {{#parentPage:PXV:IUIX_CmdBar#Methods|InsertNewBox|method}} | ||
| + | {{ToReview}} | ||
| − | + | Inserts new [[PXV:IUIX_CmdItemBox|command items box]] into the command bar. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertNewBox([in] BSTR pNewBoxID, [in, | + | <pre class="brush:cpp;gutter:false">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);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pNewBoxID |
| − | :[in] Value of BSTR. | + | :[in] Value of BSTR containing the new command item box'es ID. |
| − | ; | + | ;nInsertBefore |
| − | :[in, | + | :[in, defaultvalue(-1)] Value of LONG containing the insert index. |
| − | ; | + | ;nIdealSize |
| − | :[in, | + | :[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 |
| − | :[in, | + | :[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 |
| − | :[in, | + | :[in, defaultvalue(0)] Value of LONG containing the [[PXV:UIX_CmdItemBoxStyleFlags|command items box'es style]]. |
| − | ; | + | ;pItemBox |
| − | :[out, retval, | + | :[out, retval, defaultvalue(NULL)] Pointer to [[PXV:IUIX_CmdItemBox|IUIX_CmdItemBox]] containing the newly inserted command box. |
== Return Value == | == Return Value == | ||
| Line 25: | Line 33: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdBar|IUIX_CmdBar]] | |
Latest revision as of 08: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.
