IUIX_Dialog::SetItemCueText Method
From PDF XChange PDF SDK
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_Dialog::SetItemCueText Method}} | {{#customTitle:IUIX_Dialog::SetItemCueText Method}} | ||
| − | {{#parentPage:PXV:IUIX_Dialog|SetItemCueText | + | {{#parentPage:PXV:IUIX_Dialog#Methods|SetItemCueText|method}} |
| − | + | ||
| − | + | ||
| − | The | + | |
| + | Sets ''cue text'' of a required item by its text ID. The item must implement [[PXV:IUIX_Edit|IUIX_Edit]] interface. | ||
| + | |||
| + | Cue text is displayed in grey color when there is no other text in the item. | ||
== Syntax == | == Syntax == | ||
| − | <pre class="brush:cpp;gutter:false">HRESULT SetItemCueText([in] BSTR | + | <pre class="brush:cpp;gutter:false">HRESULT SetItemCueText([in] BSTR sItemID, |
| − | [in] BSTR | + | [in] BSTR sText);</pre> |
== Parameters == | == Parameters == | ||
| − | ; | + | ;sItemID |
| − | :[in] | + | :[in] text ID of a required item. |
| − | ; | + | ;sText |
| − | :[in] | + | :[in] ''cue text'' to display in the item. |
== Return Value == | == Return Value == | ||
| − | Returns S_OK if operation was successful or error code | + | Returns S_OK if the operation was successful, or will return an error code if it fails. |
== See Also == | == See Also == | ||
| − | + | [[PXV:IUIX_Dialog|IUIX_Dialog]] | |
Latest revision as of 14:40, 15 June 2015
Sets cue text of a required item by its text ID. The item must implement IUIX_Edit interface.
Cue text is displayed in grey color when there is no other text in the item.
Syntax
HRESULT SetItemCueText([in] BSTR sItemID,
[in] BSTR sText);
Parameters
- sItemID
- [in] text ID of a required item.
- sText
- [in] cue text to display in the item.
Return Value
Returns S_OK if the operation was successful, or will return an error code if it fails.
