| LibreOffice
    LibreOffice 25.2 SDK API Reference | 
provides access to a smart tag recognizer. More...
import "XSmartTagRecognizer.idl";
 
  
| Public Member Functions | |
| string | getName ([in] ::com::sun::star::lang::Locale aLocale) | 
| obtains a name that describes this recognizer component. | |
| string | getDescription ([in] ::com::sun::star::lang::Locale aLocale) | 
| obtains a detailed description of this recognizer component. | |
| string | getSmartTagName ([in] long nSmartTagIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| obtains the name of one specific smart tag type supported by this recognizer component. | |
| string | getSmartTagDownloadURL ([in] long nSmartTagIndex) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| obtains the URL that can be used to download new or updated recognizers. | |
| void | recognize ([in] string aText, [in] long nStart, [in] long nLength, [in] SmartTagRecognizerMode eDataType, [in] com::sun::star::lang::Locale aLocale, [in] com::sun::star::text::XTextMarkup xTextMarkup, [in] string aApplicationName, [in] com::sun::star::frame::XController xController, [in] com::sun::star::i18n::XBreakIterator xTokenizer) | 
| recognizes smart tags. | |
| boolean | hasPropertyPage ([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| indicates whether there is a property page for a smart tag type. | |
| void | displayPropertyPage ([in] long nSmartTagIndex, [in] ::com::sun::star::lang::Locale aLocale) raises ( com::sun::star::lang::IndexOutOfBoundsException ) | 
| launches the property page for a smart tag type. | |
| Public Member Functions inherited from XInitialization | |
| void | initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception ) | 
| initializes the object. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
| Public Attributes | |
| long | SmartTagCount | 
| The number of smart tag types supported by this recognizer component. | |
provides access to a smart tag recognizer.
| void displayPropertyPage | ( | [in] long | nSmartTagIndex, | |||
| [in] ::com::sun::star::lang::Locale | aLocale ) | |||||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
launches the property page for a smart tag type.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). | 
| aLocale | Is used for localization of the property page. | 
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount | 
| string getDescription | ( | [in] ::com::sun::star::lang::Locale | aLocale | ) | 
obtains a detailed description of this recognizer component.
| aLocale | Is used for localization of the description. | 
| string getName | ( | [in] ::com::sun::star::lang::Locale | aLocale | ) | 
obtains a name that describes this recognizer component.
| aLocale | Is used for localization of the name. | 
| string getSmartTagDownloadURL | ( | [in] long | nSmartTagIndex | ) | ||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
obtains the URL that can be used to download new or updated recognizers.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). | 
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount | 
| string getSmartTagName | ( | [in] long | nSmartTagIndex | ) | ||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
obtains the name of one specific smart tag type supported by this recognizer component.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). | 
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount | 
| boolean hasPropertyPage | ( | [in] long | nSmartTagIndex, | |||
| [in] ::com::sun::star::lang::Locale | aLocale ) | |||||
| raises | ( | com::sun::star::lang::IndexOutOfBoundsException ) | ||||
indicates whether there is a property page for a smart tag type.
| nSmartTagIndex | Index of the wanted smart tag type. Value needs to be between 0 and the number of smarttags available (exclusively). | 
| aLocale | Is used for localization of the property page. | 
| com::sun::star::lang::IndexOutOfBoundsException | if nSmartTagIndex is greater than SmartTagCount | 
| void recognize | ( | [in] string | aText, | 
| [in] long | nStart, | ||
| [in] long | nLength, | ||
| [in] SmartTagRecognizerMode | eDataType, | ||
| [in] com::sun::star::lang::Locale | aLocale, | ||
| [in] com::sun::star::text::XTextMarkup | xTextMarkup, | ||
| [in] string | aApplicationName, | ||
| [in] com::sun::star::frame::XController | xController, | ||
| [in] com::sun::star::i18n::XBreakIterator | xTokenizer ) | 
recognizes smart tags.
| aText | The text that should be scanned by the recognizer. aText is UTF-16 encoded. | 
| nStart | Denotes the start position of the region to scan. | 
| nLength | Denotes the length of the text to scan. | 
| eDataType | This value indicates the type of the passed text. | 
| aLocale | Is used to indicate the language of the passed text. | 
| xTextMarkup | This object is used to submit any recognized smart tags to the calling application. | 
| aApplicationName | A string containing the name of the calling application. | 
| xController | The current controller of the document. | 
| xTokenizer | This can be used to tokenize the string to recognize. | 
| 
 | attributereadonly | 
The number of smart tag types supported by this recognizer component.