<html> <head> <title>Interface XLinkageSupport</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="XLinkageSupport-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">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">embed</a> :: </p> </td> </tr> <tr> <td class="title">interface XLinkageSupport</td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XLinkageSupport</strong> ┗ <a href="XCommonEmbedPersist.html">XCommonEmbedPersist</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left"><a href="XCommonEmbedPersist.html">XCommonEmbedPersist</a></td> <td class="imsum_right"><dl> <dt>(referenced interface's summary:)</dt> <dd>specifies common implementation for embedded objects and links persistence. </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies an additional implementation for linked embedded object support. </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="#breakLink">breakLink</a></td> <td class="imsum_right">breaks the link and provides the object with a parent storage and a name for object's entry </td> </tr> <tr> <td class="imsum_left"><a href="#isLink">isLink</a></td> <td class="imsum_right">allows to detect whether the object is a linked one. </td> </tr> <tr> <td class="imsum_left"><a href="#getLinkURL">getLinkURL</a></td> <td class="imsum_right">returns the URL of the link object. </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="breakLink" class="membertitle">breakLink</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>breakLink</b>(</td> <td valign="top">[in] <a href="XStorage.html">XStorage</a></td> <td valign="bottom"> xStorage,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> sEntryName )</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>,<br> <a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/IOException.html">IOException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>breaks the link and provides the object with a parent storage and a name for object's entry </dd> <dd><p> This method can be used only for links implementations that implement the whole set of embedded object interfaces. Usually the sets of interfaces are the same for links and objects. An example of exception from this are OOo links that do not implement <a href="XEmbedPersist.html">XEmbedPersist</a> interface. For such cases the method will throw an exception. </p> <p> The link will be broken and the linked object will become a normal embedded object. </p> <p> An entry with the specified name should be created\opened inside provided storage. This entry will be used for the object persistence. If the entry exists already all it's contents will be ignored. </p> </dd> <dt><b>Parameter xStorage</b></dt> <dd>a parent storage the entry should be created\opened in </dd> <dt><b>Parameter sEntryName</b></dt> <dd>a name for the entry </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::lang::IllegalArgumentException one of arguments is illegal </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state or not a linked object </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::io::IOException in case object has not persistence or other io problems </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::uno::Exception in case of other problems </dd> <dt><b>See also</b></dt> <dd><a href="#also">also</a><br> XEmbedPersist::setPersistentEntry </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isLink" class="membertitle">isLink</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>isLink</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>allows to detect whether the object is a linked one. </dd> <dd><p> Most of embedded objects will not support this interface, but some of them can do it, to allow conversion from link to object. After the conversion the object does not change, so interface set stays the same, but the object is not a link any more. </p> </dd> <dt><b>Returns</b></dt> <dd><b>true</b> - the object is a linked one. <b>false</b> - otherwise </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLinkURL" class="membertitle">getLinkURL</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>getLinkURL</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="WrongStateException.html">WrongStateException</a>,<br> ::com::sun::star::<a href="../uno/module-ix.html">uno</a>::<a href="../uno/Exception.html">Exception</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the URL of the link object. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::embed::WrongStateException the object is in wrong state or is not a link </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>
