<html> <head> <title>Interface XSheetLinkable</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="XSheetLinkable-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Sheet_Links" 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">sheet</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">deprecated </td> <td width="50%" class="title">interface XSheetLinkable</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dt><b>Description</b></dt> <dd>enables a sheet to refer to another sheet in a different document. </dd> <dd><p>To insert a sheet link, the sheet used as linked sheet has to exist already. The method <a href="XSheetLinkable.html#link">link</a> creates a <a href="SheetLink.html">SheetLink</a> object in the document's <a href="SheetLinks.html">SheetLinks</a> collection and links the sheet to the specified external sheet.</p> </dd> <dt><b>See also</b></dt> <dd><a href="SheetLinks.html">SheetLinks</a>, <a href="SheetLink.html">SheetLink</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Spreadsheets/Sheet_Links">Spreadsheets - Sheet Links</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="#getLinkMode">getLinkMode</a></td> <td class="imsum_right">returns the link mode of the spreadsheet. </td> </tr> <tr> <td class="imsum_left"><a href="#setLinkMode">setLinkMode</a></td> <td class="imsum_right">enables the linking of the sheet and controls whether formulas are copied. </td> </tr> <tr> <td class="imsum_left"><a href="#getLinkUrl">getLinkUrl</a></td> <td class="imsum_right">returns the target URL of the link. </td> </tr> <tr> <td class="imsum_left"><a href="#setLinkUrl">setLinkUrl</a></td> <td class="imsum_right">sets the target URL of the link. </td> </tr> <tr> <td class="imsum_left"><a href="#getLinkSheetName">getLinkSheetName</a></td> <td class="imsum_right">returns the sheet name of the sheet in the source document. </td> </tr> <tr> <td class="imsum_left"><a href="#setLinkSheetName">setLinkSheetName</a></td> <td class="imsum_right">sets the name of the linked sheet in the source document. </td> </tr> <tr> <td class="imsum_left"><a href="#link">link</a></td> <td class="imsum_right">links the sheet to another sheet in another document. </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="getLinkMode" class="membertitle">getLinkMode</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="SheetLinkMode.html">SheetLinkMode</a></td> </tr> <tr> <td valign="top"><b>getLinkMode</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the link mode of the spreadsheet. </dd> <dd><p>If the returned value is <b>SheetLinkMode::NORMAL</b>, formulas are copied. With <b>SheetLinkMode::VALUE</b>, only results of formulas are used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLinkMode" class="membertitle">setLinkMode</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>setLinkMode</b>(</td> <td valign="top">[in] <a href="SheetLinkMode.html">SheetLinkMode</a></td> <td valign="bottom"> nLinkMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enables the linking of the sheet and controls whether formulas are copied. </dd> <dt><b>Parameter nLinkMode</b></dt> <dd>the value specifying the link mode for this spreadsheet. <p>If the value is <b>SheetLinkMode::NORMAL</b>, formulas are copied. With <b>SheetLinkMode::VALUE</b>, only results of formulas are used.</p> </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> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the target URL of the link. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLinkUrl" class="membertitle">setLinkUrl</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>setLinkUrl</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLinkUrl );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the target URL of the link. </dd> <dd><p>A <a href="SheetLink.html">SheetLink</a> object with the same file name must exist already or the link will not work.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getLinkSheetName" class="membertitle">getLinkSheetName</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>getLinkSheetName</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the sheet name of the sheet in the source document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setLinkSheetName" class="membertitle">setLinkSheetName</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>setLinkSheetName</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aLinkSheetName );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the name of the linked sheet in the source document. </dd> <dd><p>This method sets the sheet name in the <a href="SheetLink.html">SheetLink</a> object, it does not modify the sheet name in the source document.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="link" class="membertitle">link</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>link</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aUrl,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aSheetName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aFilterName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aFilterOptions,</td> </tr> <tr> <td/><td valign="top">[in] <a href="SheetLinkMode.html">SheetLinkMode</a></td> <td valign="bottom"> nMode );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>links the sheet to another sheet in another document. </dd> <dd><p>A <a href="SheetLink.html">SheetLink</a> object is created if it does not exist, and the link mode, the URL of the linked document and the linked sheet name are set.</p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 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>