IUIX_Combo::InsertItem Method
From PDF XChange PDF SDK
m (Automatic page editing by robot) |
|||
| Line 2: | Line 2: | ||
{{#customTitle:IUIX_Combo::InsertItem Method}} | {{#customTitle:IUIX_Combo::InsertItem Method}} | ||
{{#parentPage:PXV:IUIX_Combo|InsertItem Method|method}} | {{#parentPage:PXV:IUIX_Combo|InsertItem Method|method}} | ||
| − | |||
{{ToReview}} | {{ToReview}} | ||
| − | + | Inserts ''new item'' into [[PXV:IUIX_Combo|combo box]]. | |
== Syntax == | == Syntax == | ||
| Line 17: | Line 16: | ||
== Parameters == | == Parameters == | ||
;nInsertBefore | ;nInsertBefore | ||
| − | :[in] | + | :[in] specifies the position in a list before which a new item should be inserted. To insert new item at the end of combo box list, set this parameter to -1. |
;pText | ;pText | ||
| − | :[in] | + | :[in] specifies text of the new item. |
;pTooltip | ;pTooltip | ||
| − | :[in, defaultvalue("")] | + | :[in, defaultvalue("")] specifies item tooltip. |
;pImage | ;pImage | ||
| − | :[in, optional] | + | :[in, optional] adds item image, displayed to the left of item text. '''pImage''' object should implement [[PXV:IUIX_Icon|IUIX_Icon]] or [[PXV:IUIX_ImageData|IUIX_ImageData]] interface. |
;nItemParam | ;nItemParam | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] sets optional item parameter. |
;nItemStyle | ;nItemStyle | ||
| − | :[in, defaultvalue(0)] | + | :[in, defaultvalue(0)] sets item style flags. See [[PXV:UIX_ComboItemStyleFlags|UIX_ComboItemStyleFlags]] enumeration for full list of possible item styles. |
== Return Value == | == Return Value == | ||
| Line 33: | Line 32: | ||
== See Also == | == See Also == | ||
| − | See also [[PXV:IUIX_Combo|IUIX_Combo]]. | + | See also [[PXV:IUIX_Combo|IUIX_Combo]], [[PXV:UIX_ComboItemStyleFlags|UIX_ComboItemStyleFlags]]. |
Revision as of 04:31, 8 May 2015
Inserts new item into combo box.
Contents
Syntax
HRESULT InsertItem([in] LONG nInsertBefore,
[in] BSTR pText,
[in, defaultvalue("")] BSTR pTooltip,
[in, defaultvalue(NULL)] IUnknown* pImage,
[in, defaultvalue(0)] PARAM_T nItemParam,
[in, defaultvalue(0)] LONG nItemStyle);
Parameters
- nInsertBefore
- [in] specifies the position in a list before which a new item should be inserted. To insert new item at the end of combo box list, set this parameter to -1.
- pText
- [in] specifies text of the new item.
- pTooltip
- [in, defaultvalue("")] specifies item tooltip.
- pImage
- [in, optional] adds item image, displayed to the left of item text. pImage object should implement IUIX_Icon or IUIX_ImageData interface.
- nItemParam
- [in, defaultvalue(0)] sets optional item parameter.
- nItemStyle
- [in, defaultvalue(0)] sets item style flags. See UIX_ComboItemStyleFlags enumeration for full list of possible item styles.
Return Value
Returns S_OK if operation was successful or error code in other cases.
See Also
See also IUIX_Combo, UIX_ComboItemStyleFlags.
