<html> <head> <title>Interface XAccessibleHypertext</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="XAccessibleHypertext-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleHypertext" class="navimain">Devguide</a></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">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</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">accessibility</a> :: </p> </td> </tr> <tr> <td class="title">interface XAccessibleHypertext</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XAccessibleHypertext</strong> ┗ <a href="XAccessibleText.html">XAccessibleText</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XAccessibleText.html">XAccessibleText</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>Implement this interface to give read-only access to a text. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Implement this interface to expose the hypertext structure of a document. </dd> <dd><p>The <a href="XAccessibleHypertext.html">XAccessibleHypertext</a> interface is the main interface to expose hyperlinks in a document, typically a text document, that are used to reference other (parts of) documents. For supporting the <a href="XAccessibleHypertext.html#getLinkIndex">getLinkIndex</a> method of this interface and other character related methods of the <a href="XAccessibleHyperlink.html">XAccessibleHyperlink</a> interface, it is necessary to also support the <a href="XAccessibleText.html">XAccessibleText</a> interface.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2</dd> <dt><b>See also</b></dt> <dd>XAccessibleHyperlink,<br> XAccessibleText </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Accessibility/XAccessibleHypertext">Accessibility - XAccessibleHypertext</a></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="#getHyperLinkCount">getHyperLinkCount</a></td> <td class="imsum_right">Returns the number of links and link groups contained within this hypertext document. </td> </tr> <tr> <td class="imsum_left"><a href="#getHyperLink">getHyperLink</a></td> <td class="imsum_right">Return the specified link. </td> </tr> <tr> <td class="imsum_left"><a href="#getHyperLinkIndex">getHyperLinkIndex</a></td> <td class="imsum_right">Returns the index of the hyperlink that is associated with this character index. </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="getHyperLinkCount" class="membertitle">getHyperLinkCount</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>getHyperLinkCount</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Returns the number of links and link groups contained within this hypertext document. </dd> <dt><b>Returns</b></dt> <dd>The number of links and link groups within this hypertext document. Returns 0 if there is no link. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHyperLink" class="membertitle">getHyperLink</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"><a href="XAccessibleHyperlink.html">XAccessibleHyperlink</a></td> </tr> <tr> <td valign="top"><b>getHyperLink</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nLinkIndex )</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>Return the specified link. </dd> <dd><p>The returned <a href="XAccessibleHyperlink.html">XAccessibleHyperlink</a> object encapsulates the hyperlink and provides several kinds of information describing it.</p> </dd> <dt><b>Parameter nLinkIndex</b></dt> <dd>This index specifies the hyperlink to return. </dd> <dt><b>Returns</b></dt> <dd>If the given index is valid, i.e. lies in the interval from 0 to the number of links minus one, a reference to the specified hyperlink object is returned. If the index is invalid then an empty reference is returned. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getHyperLinkIndex" class="membertitle">getHyperLinkIndex</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>getHyperLinkIndex</b>(</td> <td valign="top">[in] long</td> <td valign="bottom"> nCharIndex )</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>Returns the index of the hyperlink that is associated with this character index. </dd> <dd><p>In a HTML document this is the case when a <a href> tag spans (includes) the given character index.</p> </dd> <dt><b>Parameter nCharIndex</b></dt> <dd>Index of the character for which to return the link index. If the <a href="XAccessibleText.html">XAccessibleText</a> interface is used to represent the text containing the link, then the character index is only valid if it is greater than or equal to zero and lower then the number of characters in the text. See that interface's documentation for more details. </dd> <dt><b>Returns</b></dt> <dd>Returns the index of the hyperlink that is associated with this character index, or throws an exception if there is no hyperlink associated with this index. </dd> <dt><b>See also</b></dt> <dd>XAccessibleText.</dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
