Methods' Details |
getName
string |
getName( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- obtains a name that describes this action component.
- Parameter aLocale
- Is used for localization of the name.
- Returns
- the name describing the action component.
|
|
getDescription
string |
getDescription( |
[in] ::com::sun::star::lang::Locale |
aLocale ); |
- Description
- obtains a detailed description of this action component.
- Parameter aLocale
- Is used for localization of the description.
- Returns
- the description of the action component.
|
|
getSmartTagName
- Description
- obtains the name of one specific smart tag type supported by
this action component.
- Parameter nSmartTagIndex
- Index of the wanted smart tag type. Value needs to be
between 0 and the number of smarttags available
(exclusively).
- Returns
- an 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.
|
|
getSmartTagCaption
- Description
- obtains the caption of the smart tag type for using in user
interfaces.
- 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 caption.
- Returns
- the caption associated with the smart tag type.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if nSmartTagIndex is greater than SmartTagCount
|
|
getActionCount
long |
getActionCount( |
[in] string |
aSmartTagName, |
| [in] ::com::sun::star::frame::XController |
xController ); |
- Description
- obtains the number of actions provided for a specify smart tag
type.
- Parameter aSmartTagName
- Name of the wanted smart tag type. This is one of the
names obtained by getSmartTagName()
- Parameter xController
- The current controller of the document.
- Returns
- the number of actions available for the given smart tag
type.
|
|
getActionID
- Description
- obtains a unique integer identifier for an action.
- Parameter aSmartTagName
- Name of the wanted smart tag type. This is one of the
names obtained by getSmartTagName()
- Parameter nActionIndex
- The index of the action for the given smart tag type.
- Parameter xController
- The current controller of the document.
- Returns
- the unique integer identifier for the requested action.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the specified nActionIndex is greater than the number
of available actions for the specified smart tag type.
|
|
getActionCaptionFromID
- Description
- obtains a caption for a specified action for use in user
interfaces.
- Parameter nActionID
- The identifier of the requested action.
- Parameter aApplicationName
- A string containing the name of the calling application.
- Parameter aLocale
- Is used for localization of the caption.
- Parameter xProperties
- Contains additional smart tag properties collected by
the smart tag recognizer.
- Parameter aText
- The calling application can pass the text of the smart
tag to the action component.
- Parameter aXML
- A string that is a XML representation of the smart tag.
- Parameter xController
- The current controller of the document.
- Parameter xTarget
- A text range representing the smart tag in the document.
- Returns
- the caption of the requested action.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
|
|
getActionNameFromID
- Description
- obtains a language independent name of an action.
- Parameter nActionID
- The identifier of the requested action.
- Parameter xController
- The current controller of the document.
- Returns
- the language independent name of the specified action.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
|
|
invokeAction
- Description
- invokes an action.
- Parameter nActionID
- The identifier of the requested action.
- Parameter aApplicationName
- A string containing the name of the calling application.
- Parameter xController
- The current controller of the document.
- Parameter xTarget
- A text range representing the smart tag in the document.
- Parameter xProperties
- Contains the smart tag properties collected by the smart
tag recognizer.
- Parameter aText
- The calling application can pass the text of the smart
tag to the action component.
- Parameter aXML
- A string that is a XML representation of the smart tag.
- Parameter aLocale
- Is used for localization of the action.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
|
|
isCaptionDynamic
- Description
- determines whether a caption is dynamic.
- Parameter nActionID
- The identifier of the requested action.
- Parameter aApplicationName
- A string containing the name of the calling application.
- Parameter xController
- The current controller of the document.
- Parameter aLocale
- Is used for localization.
- Returns
- a boolean indicating whether the caption is dynamic.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
|
|
isShowSmartTagIndicator
- Description
- determines whether the smart tag indicator should be visible.
- Parameter nActionID
- The identifier of the requested action.
- Parameter aApplicationName
- A string containing the name of the calling application.
- Parameter xController
- The current controller of the document.
- Parameter aLocale
- Is used for localization.
- Returns
- a boolean indicating whether the smart tag indicator
should be visible.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the ActionID is not recognized.
|
|
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.