Methods' Details |
getName
string |
getName( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- obtains a name that describes this recognizer component.
- Parameter aLocale
- Is used for localization of the name.
- Returns
- the name of the recognizer component.
|
|
getDescription
string |
getDescription( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- obtains a detailed description of this recognizer component.
- Parameter aLocale
- Is used for localization of the description.
- Returns
- the description of the recognizer component.
|
|
getSmartTagName
- Description
- obtains the name of one specific smart tag type supported by
this recognizer component.
- Parameter nSmartTagIndex
- Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
- Returns
- the unique name of the smart tag type. Smart tag type
names are always in the format of namespaceURI#tagname.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
|
|
getSmartTagDownloadURL
- Description
- obtains the URL that can be used to download new or updated
recognizers.
- Parameter nSmartTagIndex
- Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
- Returns
- the download URL.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
|
|
recognize
- Description
- recognizes smart tags.
- Parameter aText
- The text that should be scanned by the recognizer. aText
is UTF-16 encoded.
- Parameter nStart
- Denotes the start position of the region to scan.
- Parameter nLength
- Denotes the length of the text to scan.
- Parameter eDataType
- This value indicates the type of the passed text.
- Parameter aLocale
- Is used to indicate the language of the passed text.
- Parameter xTextMarkup
- This object is used to submit any recognized smart tags
to the calling application.
- Parameter aApplicationName
- A string containing the name of the calling application.
- Parameter xController
- The current controller of the document.
- Parameter xTokenizer
- This can be used to tokenize the string to recognize.
|
|
hasPropertyPage
- Description
- indicates whether there is a property page for a smart tag type.
- Parameter nSmartTagIndex
- Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
- Parameter aLocale
- Is used for localization of the property page.
- Returns
- true if there is a property page matching the requested
smart tag type and locale.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
|
|
displayPropertyPage
- Description
- launches the property page for a smart tag type.
- Parameter nSmartTagIndex
- Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
- Parameter aLocale
- Is used for localization of the property page.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
|
|
Copyright © 1995, 2012, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.