<tdclass="content75">The <ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide"title="link to the Developer's Guide in the Wiki">Developer's Guide</a> comes
<ahref="#examples"title="link to the examples overview"><imgclass="navigate"src="../docs/images/nav_up.png"></a>
<ahref="../index.html"title="link to the SDK start page"><imgclass="navigate"src="../docs/images/nav_home.png"></a>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Text Document Examples</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">BookmarkInsertion</a></td>
<tdclass="cell80">This application connects to the office server and
gets the <ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened
and an example text will be entered. Afterwards, some bookmarks will be
inserted.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">HardFormatting</a></td>
<tdclass="cell80">This program connects to the office server and gets
the <ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Furthermore, an empty text document will be
opened, an example text will be entered, some text attributes will be
inspected, and the <ahref="../docs/common/ref/com/sun/star/beans/PropertyState.html"title="link into the IDL reference to the enum com.sun.star.beans.PropertyState"> PropertyState</a> will be checked from the selection.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">SWriter</a></td>
<tdclass="cell80">The program connects to the office server and gets the
<ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, some
text will be entered, and a text table, a colored text, and text frame
will be inserted.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">StyleCreation</a></td>
<tdclass="cell80">The example connects to the office server and gets the
<ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, a new
paragraph style will be created, and applied.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">StyleInitialization</a></td>
<tdclass="cell80">The program connects to the office server and gets the
<ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Thereafter, an empty text document will be
opened and an example text will be entered. The paragraph collection will
be used, in order to apply a different paragraph style on the
paragraphs.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">TextDocumentStructure</a></td>
<tdclass="cell80">The application connects to the office server and gets
the <ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be opened, an
enumeration of all paragraphs and an enumeration of all text portions
will be created.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">TextReplace</a></td>
<tdclass="cell80">The example connects to the office server and gets the
<ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. An empty text document will be created, an
example text will be inserted, and some English spelled words will be
replaced with US spelled words.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">GraphicsInserter</a></td>
<tdclass="cell80">The GraphicsInserter creates a graphics object on an
empty text document by setting its position, width, height, and URL.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Text/"title="link to the source directory of the Java Text examples">WriterSelector</a></td>
<tdclass="cell80">This class gives you information on the selected
objects (text range, text frame, or graphics) at an OpenOffice.org
<tdclass="cell20"><ahref="java/Spreadsheet/"title="link to the source directory of the Java Spreadsheet examples">CalcAddins</a></td>
<tdclass="cell80">This component adds new functions to the spreadsheet
application. After registering the component, the inserted functions can
be found with help of the functions autopilot. The new functions are
assigned to the category <i>Add-in</i>.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Spreadsheet/"title="link to the source directory of the Java Spreadsheet examples">ChartTypeChange</a></td>
<tdclass="cell80">This class loads an [PRODUCTNAME] Calc document and
changes the type of the embedded chart.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Spreadsheet/"title="link to the source directory of the Java Spreadsheet examples">EuroAdaption</a></td>
<tdclass="cell80">The application connects to the office server and gets
the <ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>, opens an empty Calc document, enters an
example text, sets the number format to DM, changes the number format to
EUR (Euro), and uses the DM/EUR factor on each cell with content.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Spreadsheet/"title="link to the source directory of the Java Spreadsheet examples">SCalc</a></td>
<tdclass="cell80">The program connects to the office server and gets the
<ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Then an empty calc document will be opened,
cell styles will be created, some data will be inserted into the sheets,
and the created cell styles will be applied. Finally, a 3D chart will be
inserted.</td>
</tr>
<tbody>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Drawing Document Examples</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Drawing/"title="link to the source directory of the Java Drawing examples">SDraw</a></td>
<tdclass="cell80">This program connects to the office server and gets
the <ahref="../docs/common/ref/com/sun/star/lang/XMultiComponentFactory.html"title="link into the IDL reference to the interface com.sun.star.lang.XMultiComponentFactory"> multi component factory</a>. Afterwards, an empty text document will
be created and some shapes will be inserted on the draw page.</td>
</tr>
<tbody>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Document Handling Examples</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/DocumentHandling/"title="link to the source directory of the Java DocumentHandling examples">DocumentConverter</a></td>
<tdclass="cell80">The program offers a service that converts arbitrary
documents to a favored document type.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/DocumentHandling/"title="link to the source directory of the Java DocumentHandling examples">DocumentLoader</a></td>
<tdclass="cell80">The <i>DocumentLoader</i> can open a new or an
existing document.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/DocumentHandling/"title="link to the source directory of the Java DocumentHandling examples">DocumentPrinter</a></td>
<tdclass="cell80">The <i>DocumentPrinter</i> allows you to print the
favored pages of a specified document on your favored printer.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/DocumentHandling/"title="link to the source directory of the Java DocumentHandling examples">DocumentSaver</a></td>
<tdclass="cell80">The DocumentSaver shows how to save a document and
how you can change the type of your document.</td>
</tr>
<tbody>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">UNO Component Examples</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/Inspector/"title="link to the source directory of the Java Inspector example">Inspector</a></td>
<tdclass="cell80">The Instance Inspector is primarily an auxiliary tool
for the developer, which can present information about an object of the
[PRODUCTNAME] API at run-time. Depending on the object to be inspected,
appropriate methods, interfaces, services, and attributes can be displayed
to the developer. The methods, interfaces, services and attributes are
represented in a predictable tree. If the attributes contained in an
object are to be examined, the appropriate nodes in the tree can be
expanded with the help of the mouse. For each non primitive object, five
categories are offered to the user, as long as those are available with
that object.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/MinimalComponent/"title="link to the source directory of the Java MinimalComponent example">MinimalComponent</a></td>
<tdclass="cell80">This class provides a minimal UNO component. You can
take this class as a base for your own components. By extensions of this
class it is possible to also extend the function range of the Office.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/PropertySet/"title="link to the source directory of the Java PropertySet example">PropTest</a></td>
<tdclass="cell80">Contains a component that provides property set
interfaces by means of inheriting <ahref="../docs/java/ref/com/sun/star/lib/uno/helper/PropertySet.html"title="link into the Java UNO reference to the PropertySet helper class">com.sun.star.lib.uno.helper.ProperterSet</a>.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/ToDo/"title="link to the source directory of the Java ToDo example">ToDo</a></td>
<tdclass="cell80">For every to-do listed in a spreadsheet document, this
component calculates the start date, day of week of the start date, the
end date, and the day of week of the end date. All calculations are
dependent upon the values of "Needed Days", "Due Date"
and "Status". The columns "Needed Days" and
"Status" are mandatory. The first to-do should be placed in
row nine. The date to start the calculation should be placed in cell C6.
The private holidays should be placed in cell K4/K5 and below.<br>
All rows will be calculated up to the first empty cell in the first
column. If a cell in the column "Due Date" is colored red,
you should take a look at your entries.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/EmbedDocument/EmbeddedObject"title="link to the source directory of the Java EmbeddedObject example">EmbeddedObject</a></td>
<tdclass="cell80">Contains a component that provides an example of embedded object implementation.</td>
</tr>
<tbody>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Other Examples</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/ConverterServlet/"title="link to the source directory of the Java ConverterServlet examle">ConverterServlet</a></td>
<tdclass="cell80">This servlet shows how to convert arbitrary documents
on a remotely running office server. The converted document will be
pushed from the web server to the client browser. Please see the <ahref="java/ConverterServlet/README"title="link to the README file of the Java ConverterServlet example">README</a> file for further information.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="java/NotesAccess/"title="link to the source directory of the Java NotesAccess example">NotesAccess</a></td>
<tdclass="cell80">This class creates a spreadsheet document and fills it
with existing values of documents from a Lotus Notes database. For this
examples some external APIs from Lotus Notes/Domino are necessary. You
can download a trial version from <ahref="http:///www.lotus.com/downloads">http:///www.lotus.com/downloads</a>. After installing please add the install path
to the PATH or LD_LIBRARY_PATH of your SDK environment and either copy
the "Notes.jar" into your <OFFICE_CLASSES_DIR> directory
or adapt the SDK_CLASSPATH variable in the example Makefile to use the
<ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/WritingUNO/Simple_Component_in_Java"title="link to the "Simple component in Java" chapter in the Developer's Guide">How to write a UNO component in Java</a><br>
<ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Java/Java_Language_Binding"title="link to the "Java UNO Language Bnding" chapter in the Developer's Guide">Java UNO Language Binding</a><br>
<ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/WritingUNO/Debugging"title="link to the "Debugging Java components" chapter in the Developer's Guide">Debugging Java components</a><br>
<ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/WritingUNO/C%2B%2B/C%2B%2B_Component"title="link to the "How to write a UNO component in C++" chapter in the Developer's Guide">How to write a UNO component in C++</a><br>
<ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/C%2B%2B/C%2B%2B_Language_Binding"title="link to the "C++ UNO Language Binding" chapter in the Developer's Guide">C++ UNO Language Binding</a><br>
<ahref="#examples"title="link to the examples overview"><imgclass="navigate"src="../docs/images/nav_up.png"></a>
<ahref="../index.html"title="link to the SDK start page"><imgclass="navigate"src="../docs/images/nav_home.png"></a>
</td>
</tr>
<tr>
<tdcolspan="3">
<p>The example programs are embedded in [PRODUCTNAME] documents in the
samples directory. To view or edit the [PRODUCTNAME] Basic source,
select the appropriate document and then select Tools->Macro.</p>
<p>Most of the examples are stand-alone, but two of them (Creating an
Index and Import/Export of ASCII Files) have an associated data file
identified by a .txt file name suffix).</p>
<p>Some of the examples are also available in Java, you can find them in
the <ahref="#Java_examples"title="link to the Java examples section">
Java section</a>.</p>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Example</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/text/modifying_text_automatically/"title="link to the source directory of the [PRODUCTNAME] Basic text/modifying_text_automatically examples">Changing Appearance</a></td>
<tdclass="cell80"> To change the style used for certain words, you can
start with the following example. This code searches for the regular
expression <code>the[a-z]</code>, which stands for the text portion the
followed by exactly one lowercase letter. All occurrences of these four
letters are then changed to bold characters. The same happens in the next
part of the program, this time changing the appearance of
<code>all[a-z]</code> to italic. In order for this example to work, you
must execute it from an open text document.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/text/modifying_text_automatically/"title="link to the source directory of the [PRODUCTNAME] Basic text/modifying_text_automatically examples">Replacing Text</a></td>
<tdclass="cell80">If you regularly receive documents from other people
for editing, you might want to make sure that certain words are always
written the same. The next example illustrates this by forcing certain
words to be spelled in American English.<br>
In order for this example to work, you must execute it from an open text
document. For a real world application, it is a good idea to read the
words from an external file.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/text/modifying_text_automatically/"title="link to the source directory of the [PRODUCTNAME] Basic text/modifying_text_automatically examples">Using Regular Expressions</a></td>
<tdclass="cell80">Another application of automatic text modification is
related to stylistic questions. Suppose your company’s policy is to
avoid the use of certain words. You want to replace these words, but you
cannot do that automatically because you have to find the appropriate
replacement, which depends on the context. So instead of deleting or
replacing the offending words automatically, you change their color to
make them stand out during a subsequent manual review process.<br>
The following example handles two kinds of unwanted wordings: those
which are absolutely forbidden and must be replaced by something else,
and those which are considered bad style. A subroutine is responsible
for the changes. It can be used to make all words in a list appear in a
certain color in the text document. To keep the lists short, we use
regular expressions which provide for the variants of the words
(plural, adjective etc.).</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/text/modifying_text_automatically/"title="link to the source directory of the [PRODUCTNAME] Basic text/modifying_text_automatically examples">Inserting Bookmarks</a></td>
<tdclass="cell80">
<p>The next example does something very similar. This time, however, we
do not change the color of the words but insert a bookmark at each of
them. You can thus use the StarOffice navigator to jump directly from
word to word. Bookmarks must first be created using
<code>createInstance()</code>. They are then inserted with
<code>insertTextContent()</code> at the current text range.</p>
<p>The main difference to the preceding example is the For loop in
<code>markList()</code>. Instead of changing the color of the current
word, it creates a new bookmark, oBookmark, whose name is the current
word with an integer appended. It then inserts this bookmark at the
word.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/text/creating_an_index/"title="link to the source directory of the [PRODUCTNAME] Basic text/create_index example">Creating an Index</a></td>
<tdclass="cell80">Indices for text documents can be created manually in
[PRODUCTNAME] Writer by clicking on the words that should appear in the
index. If the document is large, or if you have to generate indices for
several documents, this task should be automated.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/sheet/"title="link to the source directory of the [PRODUCTNAME] Basic sheet example">Adapting to Euroland</a></td>
<tdclass="cell80">Most of the members of the European Union will abandon
their old currency in favor of the new Euro in 2001. This requires
modifications to all programs using the old currencies. Since the exchange
rates for the old currencies have been fixed at the end of 1999, one can
already convert old data. The following program does this for all values
in a table that are formatted with the currency string DM.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/drawing/"title="link to the source directory of the [PRODUCTNAME] Basic drawing example">Import/Export of ASCII Files</a></td>
<tdclass="cell80">You can use the drawing facilities of StarOffice API
to generate a picture from ASCII input. One application would be a
hierarchical representation of a directory listing, based on textual
data.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/stock_quotes_updater/"title="link to the source directory of the [PRODUCTNAME] Basic stock_quotes_updater example">Stock Quotes Updater</a></td>
<tdclass="cell80">If you want to display stock charts for certain
companies, you can open up your browser every day, go to a search engine,
look up the quote and copy it by hand into a table. Or you can use a
program that does all this automatically. The following example relies on
the sheet module. It uses URLs to obtain the current stock quotes. The
quotes are displayed in sheets, one for each company. We show a line
diagram and the numerical values for this company on every sheet. The
functionality is hidden in the three subroutines <code>GetValue()</code>,
<code>UpdateValue()</code>, and <code>UpdateChart()</code>.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="basic/forms_and_controls/"title="link to the source directory of the [PRODUCTNAME] Basic forms_and_controls example">Forms and Controls</a></td>
<tdclass="cell80">The example document Burger Factory offers some forms
and controls, which you can use to order your desired burger type,
beverage, topping, and sauce. By hitting the button
"Order now!", your order will be placed.</td>
Additional information: <ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Basic/OpenOffice.org_Basic"title="link to the "[PRODUCTNAME] Basic language binding" chapter in the Developer's Guide">[PRODUCTNAME] Basic language binding</a>
<tdcolspan="2"class="head1"><aname="OLE_examples">Object Linking and Embedding (OLE) examples</td>
<tdalign="right">
<ahref="#examples"title="link to the examples overview"><imgclass="navigate"src="../docs/images/nav_up.png"></a>
<ahref="../index.html"title="link to the SDK start page"><imgclass="navigate"src="../docs/images/nav_home.png"></a>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Example</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="OLE/activex/"title="link to the source directory of the activex plugin example using the OLE bridge">ActiveX Control</a></td>
<tdclass="cell80">The ActiveX control shows an example of access to UNO
through COM technology. It requires a properly installed StarOffice
version 6.0 or OpenOffice 1.0 or newer. This is a Lite ActiveX control
so it can be used only in containers that allow the use of such controls.
It can be activated with an <OBJECT> tag from a html-page to embed
a document. Without any parameters a new writer document will be opened
for editing. For more details please see the <ahref="OLE/activex/README.txt"title="link to the README file of the activex example">README</a>.<br>
Note: This example works only under windows and if you don't use the MS
.Net C++ compiler please check the makefile and take notice of the
comments.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="OLE/vbscript/"title="link to the source directory of the VBScript example using the OLE bridge">WriterDemo</a></td>
<tdclass="cell80">This Visual Basic Script creates an empty text
document and inserts text, a table, and a text frame.</td>
Additional information: <ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/Bridge/Automation_Bridge"title="link to the "Automation Language Binding" chapter in the Developer's Guide">Automation Language Binding</a>
<tdcolspan="2"class="head1"><aname="CLI_examples">Common Language Infrastructure (CLI) examples</td>
<tdalign="right">
<ahref="#examples"title="link to the examples overview"><imgclass="navigate"src="../docs/images/nav_up.png"></a>
<ahref="../index.html"title="link to the SDK start page"><imgclass="navigate"src="../docs/images/nav_home.png"></a>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td>
<tableclass="table4">
<tbody>
<trclass="thead">
<tdclass="cell20">Example</td>
<tdclass="cell80">Description</td>
</tr>
<tr>
<tdclass="cell20"><ahref="CLI/CSharp/Spreadsheet/"title="link to the source directory of the Spreadsheet example using the CLI-UNO bridge">Spreadsheet Example</a></td>
<tdclass="cell80">This example is written in C# and shows how Spreadsheet
documents are created and filled with content. This example actually
consists of three separate executables, SpreadsheetSample.exe,
GeneralTableSample.exe, ViewSample.exe.</td>
</tr>
<tr>
<tdclass="cell20"><ahref="CLI/VB.NET/WriterDemo/"title="link to the source directory of the WriterDeom example using the CLI-UNO bridge">WriterDemo</a></td>
<tdclass="cell80">This example is written in VB.NET. It creates a text
document and inserts text, a table, and a text frame.</td>
Additional information: <ahref="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/ProUNO/CLI/CLI_Language_Binding"title="link to the "CLI-UNO Language Binding" chapter in the Developer's Guide">CLI-UNO Language Binding</a>
