Language Asturianu (ast) Català (ca) Čeština (cs) Dansk (da) Deutsch (de) English [US] (en-US) Español (es) Esperanto (eo) Eesti keel (et) Euskara (eu) Français (fr) Gàidhlig (gd) Galego (gl) Italiano (it) Lietuvių (lt) Magyar (hu) Nederlands (nl) Norsk (no) Polski (pl) Português [do Brasil] (pt-BR) Português [Europeu] (pt) Română (ro) Slovenčina (sk) Slovenščina (sl) Suomi (fi) Svenska (sv) Yкраїнська (uk) Tiếng Việt (vi) Türkçe (tr) ኦሮሚኛ (om) Հայերեն (hy) Ελληνικά (el) български език (bg) Русский (ru) Cрпски [ћирилицом] (sr) עברית (he) हिन्दी (hi) ភាសាខ្មែរ (km) தமிழ் (ta) ภาษาไทย (th) 简体中文 (zh-CN) 正體中文 (zh-TW) 日本語 (ja) 한국어 (ko)

The Free and Open Productivity Suite

• Product
• Download
• Support
• Blog
• Extensions & Templates
• Get Involved
• Focus Areas
• Native Languages

home » api » docs » common » ref » com » sun » star » sheet

Overview

Module

Use

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

---

:: com :: sun :: star :: sheet ::

deprecated interface XSheetLinkable

Usage Restrictions deprecated Description enables a sheet to refer to another sheet in a different document. To insert a sheet link, the sheet used as linked sheet has to exist already. The method link creates a SheetLink object in the document's SheetLinks collection and links the sheet to the specified external sheet. See also SheetLinks, SheetLink Developers Guide Spreadsheets - Sheet Links

---

Methods' Summary
getLinkMode	returns the link mode of the spreadsheet.
setLinkMode	enables the linking of the sheet and controls whether formulas are copied.
getLinkUrl	returns the target URL of the link.
setLinkUrl	sets the target URL of the link.
getLinkSheetName	returns the sheet name of the sheet in the source document.
setLinkSheetName	sets the name of the linked sheet in the source document.
link	links the sheet to another sheet in another document.

Methods' Details

getLinkMode SheetLinkMode getLinkMode(); Description returns the link mode of the spreadsheet. If the returned value is SheetLinkMode::NORMAL, formulas are copied. With SheetLinkMode::VALUE, only results of formulas are used.

setLinkMode void setLinkMode( [in] SheetLinkMode  nLinkMode ); Description enables the linking of the sheet and controls whether formulas are copied. Parameter nLinkMode the value specifying the link mode for this spreadsheet. If the value is SheetLinkMode::NORMAL, formulas are copied. With SheetLinkMode::VALUE, only results of formulas are used.

getLinkUrl string getLinkUrl(); Description returns the target URL of the link.

setLinkUrl void setLinkUrl( [in] string  aLinkUrl ); Description sets the target URL of the link. A SheetLink object with the same file name must exist already or the link will not work.

getLinkSheetName string getLinkSheetName(); Description returns the sheet name of the sheet in the source document.

setLinkSheetName void setLinkSheetName( [in] string  aLinkSheetName ); Description sets the name of the linked sheet in the source document. This method sets the sheet name in the SheetLink object, it does not modify the sheet name in the source document.

link void link( [in] string  aUrl, [in] string  aSheetName, [in] string  aFilterName, [in] string  aFilterOptions, [in] SheetLinkMode  nMode ); Description links the sheet to another sheet in another document. A SheetLink 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.

Top of Page

---

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The ASF logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.