Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > fc480f9d5aabed8eeaffe8ad3401a94c > files > 6290

openoffice.org-devel-doc-3.2.1-0.3mdv2010.2.i586.rpm

<html>
<head>
<title>Interface XSmartTagAction</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XSmartTagAction-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#AttributesSummary" class="navisub">Attributes' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub"><a href="#AttributesDetails" class="navisub">Attributes' Details</a></td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">smarttags</a> :: </p>
</td>
</tr>
<tr>
<td class="title"><table class="title-table" width="99%">
<tr>
<td width="25%" class="title2">unpublished </td>
<td width="50%" class="title">interface XSmartTagAction</td>
<td width="*"/></tr>
</table>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XSmartTagAction</strong>
&#x2517 ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a>

</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XInitialization.html">XInitialization</a></td>
<td class="imsum_right"><dl>
<dt>(referenced interface's summary:)</dt>
<dd>initializes an object directly after its creation.
 
 </dd>
</dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<dt><b>Usage Restrictions</b></dt>
<dd><i>not published</i></dd>
<dt><b>Description</b></dt>
<dd>provides access to smart tag actions.

 </dd>
<dt><b>Since </b></dt>
<dd>OpenOffice 2.3.0</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getName">getName</a></td>
<td class="imsum_right">obtains a name that describes this action component.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getDescription">getDescription</a></td>
<td class="imsum_right">obtains a detailed description of this action component.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSmartTagName">getSmartTagName</a></td>
<td class="imsum_right">obtains the name of one specific smart tag type supported by
 this action component.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getSmartTagCaption">getSmartTagCaption</a></td>
<td class="imsum_right">obtains the caption of the smart tag type for using in user
 interfaces.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getActionCount">getActionCount</a></td>
<td class="imsum_right">obtains the number of actions provided for a specifiy smart tag
 type.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getActionID">getActionID</a></td>
<td class="imsum_right">obtains a unique integer identifier for an action.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getActionCaptionFromID">getActionCaptionFromID</a></td>
<td class="imsum_right">obtains a caption for a specified action for use in user
 interfaces.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getActionNameFromID">getActionNameFromID</a></td>
<td class="imsum_right">obtains a language independant name of an action.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#invokeAction">invokeAction</a></td>
<td class="imsum_right">invokes an action.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isCaptionDynamic">isCaptionDynamic</a></td>
<td class="imsum_right">determines whether a caption is dynamic.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#isShowSmartTagIndicator">isShowSmartTagIndicator</a></td>
<td class="imsum_right">determines whether the smart tag indicator should be visible.

 &nbsp;</td>
</tr>
</table>
<a name="AttributesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Attributes' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#SmartTagCount">SmartTagCount</a></td>
<td class="imsum_right">the number of smart tag types supported by this action
 component.
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="getName" class="membertitle">getName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getName</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains a name that describes this action component.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization of the name.

 </dd>
<dt><b>Returns</b></dt>
<dd>the name describing the action component.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getDescription" class="membertitle">getDescription</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getDescription</b>(</td>
<td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains a detailed description of this action component.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization of the description.

 </dd>
<dt><b>Returns</b></dt>
<dd>the description of the action component.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSmartTagName" class="membertitle">getSmartTagName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getSmartTagName</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nSmartTagIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains the name of one specific smart tag type supported by
 this action component.

 </dd>
<dt><b>Parameter nSmartTagIndex</b></dt>
<dd>Index of the wanted smart tag type. Value needs to be
 between 0 and the number of smarttags available
 (exclusively).

 </dd>
<dt><b>Returns</b></dt>
<dd>an unique name of the smart tag type. Smart tag type
 names are always in the format of namespaceURI#tagname.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundsException
 if nSmartTagIndex is greater than SmartTagCount.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getSmartTagCaption" class="membertitle">getSmartTagCaption</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getSmartTagCaption</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nSmartTagIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains the caption of the smart tag type for using in user
 interfaces.

 </dd>
<dt><b>Parameter nSmartTagIndex</b></dt>
<dd>Index of the wanted smart tag type. Value needs to be
 between 0 and the number of smarttags available
 (exclusively).

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization of the caption.

 </dd>
<dt><b>Returns</b></dt>
<dd>the caption associated with the smart tag type.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IndexOutOfBoundsException
 if nSmartTagIndex is greater than SmartTagCount
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getActionCount" class="membertitle">getActionCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getActionCount</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aSmartTagName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains the number of actions provided for a specifiy smart tag
 type.

 </dd>
<dt><b>Parameter aSmartTagName</b></dt>
<dd>Name of the wanted smart tag type. This is one of the
 names obtained by getSmartTagName()

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Returns</b></dt>
<dd>the number of actions available for the given smart tag
 type.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getActionID" class="membertitle">getActionID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">long</td>
</tr>
<tr>
<td valign="top"><b>getActionID</b>(</td>
<td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aSmartTagName,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionIndex,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains a unique integer identifier for an action.

 </dd>
<dt><b>Parameter aSmartTagName</b></dt>
<dd>Name of the wanted smart tag type. This is one of the
 names obtained by getSmartTagName()

 </dd>
<dt><b>Parameter nActionIndex</b></dt>
<dd>The index of the action for the given smart tag type.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Returns</b></dt>
<dd>the unique integer identifier for the requested action.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the specified nActionIndex is greater than the number
 of available actions for the specified smart tag type.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getActionCaptionFromID" class="membertitle">getActionCaptionFromID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getActionCaptionFromID</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionID,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aApplicationName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XStringKeyMap.html">XStringKeyMap</a></td>
<td valign="bottom">&nbsp;xProperties,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aText,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aXML,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/XTextRange.html">XTextRange</a></td>
<td valign="bottom">&nbsp;xTarget )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains a caption for a specified action for use in user
 interfaces.

 </dd>
<dt><b>Parameter nActionID</b></dt>
<dd>The identifier of the requested action.

 </dd>
<dt><b>Parameter aApplicationName</b></dt>
<dd>A string containing the name of the calling application.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization of the caption.

 </dd>
<dt><b>Parameter xProperties</b></dt>
<dd>Contains additional smart tag properties collected by
 the smart tag recognizer.

 </dd>
<dt><b>Parameter aText</b></dt>
<dd>The calling application can pass the text of the smart
 tag to the action component.

 </dd>
<dt><b>Parameter aXML</b></dt>
<dd>A string that is a XML representation of the smart tag.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Parameter xTarget</b></dt>
<dd>A text range representing the smart tag in the document.

 </dd>
<dt><b>Returns</b></dt>
<dd>the caption of the requested action.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the ActionID is not recognized.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="getActionNameFromID" class="membertitle">getActionNameFromID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">string</td>
</tr>
<tr>
<td valign="top"><b>getActionNameFromID</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionID,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>obtains a language independant name of an action.

 </dd>
<dt><b>Parameter nActionID</b></dt>
<dd>The identifier of the requested action.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Returns</b></dt>
<dd>the language independant name of the specified action.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the ActionID is not recognized.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="invokeAction" class="membertitle">invokeAction</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>invokeAction</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionID,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aApplicationName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/XTextRange.html">XTextRange</a></td>
<td valign="bottom">&nbsp;xTarget,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XStringKeyMap.html">XStringKeyMap</a></td>
<td valign="bottom">&nbsp;xProperties,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aText,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aXML,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>invokes an action.

 </dd>
<dt><b>Parameter nActionID</b></dt>
<dd>The identifier of the requested action.

 </dd>
<dt><b>Parameter aApplicationName</b></dt>
<dd>A string containing the name of the calling application.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Parameter xTarget</b></dt>
<dd>A text range representing the smart tag in the document.

 </dd>
<dt><b>Parameter xProperties</b></dt>
<dd>Contains the smart tag properties collected by the smart
 tag recognizer.

 </dd>
<dt><b>Parameter aText</b></dt>
<dd>The calling application can pass the text of the smart
 tag to the action component.

 </dd>
<dt><b>Parameter aXML</b></dt>
<dd>A string that is a XML representation of the smart tag.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization of the action.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the ActionID is not recognized.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isCaptionDynamic" class="membertitle">isCaptionDynamic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isCaptionDynamic</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionID,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aApplicationName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines whether a caption is dynamic.

 </dd>
<dt><b>Parameter nActionID</b></dt>
<dd>The identifier of the requested action.

 </dd>
<dt><b>Parameter aApplicationName</b></dt>
<dd>A string containing the name of the calling application.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization.

 </dd>
<dt><b>Returns</b></dt>
<dd>a boolean indicating whether the caption is dynamic.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the ActionID is not recognized.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="isShowSmartTagIndicator" class="membertitle">isShowSmartTagIndicator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">boolean</td>
</tr>
<tr>
<td valign="top"><b>isShowSmartTagIndicator</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nActionID,</td>
</tr>
<tr>
<td/><td valign="top">[in] string</td>
<td valign="bottom">&nbsp;aApplicationName,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a></td>
<td valign="bottom">&nbsp;xController,</td>
</tr>
<tr>
<td/><td valign="top">[in] ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/Locale.html">Locale</a></td>
<td valign="bottom">&nbsp;aLocale )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>determines whether the smart tag indicator should be visible.

 </dd>
<dt><b>Parameter nActionID</b></dt>
<dd>The identifier of the requested action.

 </dd>
<dt><b>Parameter aApplicationName</b></dt>
<dd>A string containing the name of the calling application.

 </dd>
<dt><b>Parameter xController</b></dt>
<dd>The current controller of the document.

 </dd>
<dt><b>Parameter aLocale</b></dt>
<dd>Is used for localization.

 </dd>
<dt><b>Returns</b></dt>
<dd>a boolean indicating whether the smart tag indicator
 should be visible.

 </dd>
<dt><b>Throws</b></dt>
<dd>com::sun::star::lang::IllegalArgumentException
 if the ActionID is not recognized.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a name="AttributesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Attributes' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="SmartTagCount" class="membertitle">SmartTagCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center">
<tr>
<td>[ readonly ] long <b>SmartTagCount</b>;<hr>
<dl>
<dt><b>Description</b></dt>
<dd>the number of smart tag types supported by this action
 component.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2011, 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.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>