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

interface XSmartTagRecognizer

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

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

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

Description
Function: getSmartTagCount
Returns
Number of available smarttags of this recognizer
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 recognizer. This name is needed to associate the recognizer part of a smarttag with the action part.
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 recognizer.
Recognize
boolean
Recognize( [in] string  aWord,
[in] long  nSmartTagIndex,
[in] ::com::sun::star::frame::XController  xController );

Description
Function: Recognize
Parameter OUString
aWord Word that shall be checked by smarttag.
Parameter sal_Int32
nSmartTagIndex Index of the wanted smarttag. Value needs to be between 0 and the number of smarttags available (exclusively).
Returns
Returns true if the specified word is recognized by smarttag.
initialize
void
initialize( [in] sequence< any >  aArguments );

Description
initializes the object.

It should be called directly after the object is created.

Top of Page