IUIX_Dialog::SetItemCueText Method

From PDF XChange PDF SDK
Jump to: navigation, search
m (Automatic page editing by robot)
Line 2: Line 2:
 
{{#customTitle:IUIX_Dialog::SetItemCueText Method}}
 
{{#customTitle:IUIX_Dialog::SetItemCueText Method}}
 
{{#parentPage:PXV:IUIX_Dialog|SetItemCueText Method|method}}
 
{{#parentPage:PXV:IUIX_Dialog|SetItemCueText Method|method}}
{{ToWrite}}
 
 
{{ToReview}}
 
{{ToReview}}
  
The method of interface of PDF-XChange Editor SDK.
+
Sets ''cue text'' for a required item. Item must implement [[PXV:IUIX_Edit|IUIX_Edit]] interface.
 +
 
 +
Cue text is displayed in grey color when there is no other text in item.
  
 
== Syntax ==
 
== Syntax ==
Line 13: Line 14:
 
== Parameters ==
 
== Parameters ==
 
;pItemID
 
;pItemID
:[in]  Value of BSTR.
+
:[in]  text ID of a required item.
 
;pText
 
;pText
:[in]  Value of BSTR.
+
:[in]  ''cue text'' to display in the item.
  
 
== Return Value ==
 
== Return Value ==

Revision as of 03:09, 16 May 2015


Sets cue text for a required item. Item must implement IUIX_Edit interface.

Cue text is displayed in grey color when there is no other text in item.

Syntax

HRESULT SetItemCueText([in]  BSTR  pItemID,
                       [in]  BSTR  pText);

Parameters

pItemID
[in] text ID of a required item.
pText
[in] cue text to display in the item.

Return Value

Returns S_OK if operation was successful or error code in other cases.

See Also

See also IUIX_Dialog.