:: com :: sun :: star :: smarttags ::

interface XSmartTagAction

Methods' Summary
getName Function: getName  
getDescription Function: getDescription  
getSmartTagCount Function: getSmartTagCount  
getSmartTagName Function: getSmartTagName  
getSmartTagCaption Function: getSmartTagCaption  
getActionCount Function: getActionCount  
getActionCaption Function: getActionCaption  
invokeAction Function: invokeAction  
initialize initializes the object.  
Methods' Details
getName
string
getName();

Description
Function: getName
Returns
Name of the smarttag action library
getDescription
string
getDescription();

Description
Function: getDescription
Returns
Description of the smarttag action library
getSmartTagCount
long
getSmartTagCount();

Description
Function: getSmartTagCount
Returns
Number of available smarttags in this action library
getSmartTagName
string
getSmartTagName( [in] long  nSmartTagIndex );

Description
Function: getSmartTagName
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
Returns the name of one specific smarttag in this action library. This is needed for associating the actions with the corresponding recognizer.
getSmartTagCaption
string
getSmartTagCaption( [in] long  nSmartTagIndex,
[in] ::com::sun::star::frame::XController  xController );

Description
Function: getSmartTagCaption
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
Returns the caption of one specific smarttag in this action library.
getActionCount
long
getActionCount( [in] long  nSmartTagIndex,
[in] ::com::sun::star::frame::XController  xController );

Description
Function: getActionCount
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
Returns the number of available actions of one specific smarttag in this action library
getActionCaption
string
getActionCaption( [in] long  nSmartTagIndex,
[in] long  nActionIndex,
[in] ::com::sun::star::frame::XController  xController );

Description
Function: getActionCaption
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Parameter sal_Int32
nActionIndex Index of the wanted action. Value needs to be between 0 and the number of actions available for the specified smarttag (exclusively).
Returns
Returns the caption of an action for one specific smarttag in this action library.
invokeAction
void
invokeAction( [in] long  nSmartTagIndex,
[in] long  nActionIndex,
[in] ::com::sun::star::text::XTextRange  xRange,
[in] ::com::sun::star::frame::XController  xController );

Description
Function: invokeAction
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Parameter sal_Int32
nActionIndex Index of the wanted action. Value needs to be between 0 and the number of actions available for the specified smarttag (exclusively).
Parameter OUString
aWord Word that was recognized as actionable.
initialize
void
initialize( [in] sequence< any >  aArguments );

Description
initializes the object.

It should be called directly after the object is created.

Top of Page