IUIX_CmdPane::InsertBar Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| (6 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
[[Category:Editor]] | [[Category:Editor]] | ||
{{#customTitle:IUIX_CmdPane::InsertBar Method}} | {{#customTitle:IUIX_CmdPane::InsertBar Method}} | ||
| + | {{#parentPage:PXV:IUIX_CmdPane#Methods|InsertBar|method}} | ||
| + | {{ToReview}} | ||
| − | + | Inserts [[PXV:IUIX_CmdBar|command bar]] into the command pane's [[PXV:IUIX_CmdLine|command line]] into given position. | |
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT InsertBar([in] IUIX_CmdBar* pBar, [in, defaultvalue(-1)] LONG nLineIndex, [in, defaultvalue(-1)] LONG nBarIndex, [in, defaultvalue(0)] VARIANT_BOOL bForceToNewLine);</pre> | + | <pre class="brush:cpp;gutter:false">HRESULT InsertBar([in] IUIX_CmdBar* pBar, |
| + | [in, defaultvalue(-1)] LONG nLineIndex, | ||
| + | [in, defaultvalue(-1)] LONG nBarIndex, | ||
| + | [in, defaultvalue(0)] VARIANT_BOOL bForceToNewLine);</pre> | ||
== Parameters == | == Parameters == | ||
| − | ; | + | ;pBar |
| − | :[in] Pointer to [[PXV:IUIX_CmdBar|IUIX_CmdBar]]. | + | :[in] Pointer to [[PXV:IUIX_CmdBar|IUIX_CmdBar]] containing the command bar that would be inserted. |
| − | ; | + | ;nLineIndex |
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the index of the command line, where the command bar would be inserted. |
| − | ; | + | ;nBarIndex |
| − | :[in, defaultvalue(-1)] Value of LONG. | + | :[in, defaultvalue(-1)] Value of LONG containing the index in the command line's command bar array where the command bar would be inserted. |
| − | ; | + | ;bForceToNewLine |
| − | :[in, defaultvalue(0)] Value of VARIANT_BOOL. | + | :[in, defaultvalue(0)] Value of VARIANT_BOOL that indicates whether the new line should be created at the given line index. |
== Return Value == | == Return Value == | ||
| Line 21: | Line 27: | ||
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_CmdPane|IUIX_CmdPane]] | |
Latest revision as of 02:13, 25 March 2016
Inserts command bar into the command pane's command line into given position.
Syntax
HRESULT InsertBar([in] IUIX_CmdBar* pBar,
[in, defaultvalue(-1)] LONG nLineIndex,
[in, defaultvalue(-1)] LONG nBarIndex,
[in, defaultvalue(0)] VARIANT_BOOL bForceToNewLine);
Parameters
- pBar
- [in] Pointer to IUIX_CmdBar containing the command bar that would be inserted.
- nLineIndex
- [in, defaultvalue(-1)] Value of LONG containing the index of the command line, where the command bar would be inserted.
- nBarIndex
- [in, defaultvalue(-1)] Value of LONG containing the index in the command line's command bar array where the command bar would be inserted.
- bForceToNewLine
- [in, defaultvalue(0)] Value of VARIANT_BOOL that indicates whether the new line should be created at the given line index.
Return Value
Returns S_OK if operation was successful or error code in other cases.
