Documentation/DevGuide/Text/Saving Text Documents

OpenOffice.org Developer's Guide

Text Documents

< Previous Section

Next Section >

• Example: Fields in a Template
• Example: Visible Cursor Position

• Handling Text Document Files

• Saving Text Documents
• Printing Text Documents

• Working with Text Documents

• Editing Text
• Iterating over Text
• Inserting a Paragraph where no Cursor can go
• Sorting Text
• Inserting Text Files
• Auto Text

• Formatting
• Navigating
• Tables

• Named Table Cells in Rows, Columns and the Table Cursor
• Indexed Cells and Cell Ranges
• Table Naming, Sorting, Charting and Autoformatting
• Text Table Properties
• Inserting Tables
• Accessing Existing Tables

• Text Fields
• Bookmarks
• Indexes and Index Marks
• Reference Marks
• Footnotes and Endnotes
• Shape Objects in Text

• Text Frames
• Embedded Objects
• Graphic Objects
• Drawing Shapes

• Redline
• Ruby

• Overall Document Features

• Settings
• Line Numbering and Outline Numbering
• Text Sections
• Page Layout
• Columns
• Link Targets

• Text Document Controller

• TextView
• TextViewCursor

< Previous Page

Next Page >

Storing

Documents are storable through their interface com.sun.star.frame.XStorable. This interface is discussed in detail in Office Development. An XStorable implements these operations:

  boolean hasLocation()
  string getLocation()
  boolean isReadonly()
  void store() 
  void storeAsURL( [in] string aURL, sequence< com::sun::star::beans::PropertyValue > aArgs)
  void storeToURL( [in] string aURL, sequence< com::sun::star::beans::PropertyValue > aArgs)

The method names are evident. The method storeAsUrl() is the exact representation of File - Save As, that is, it changes the current document location. In contrast, storeToUrl() stores a copy to a new location, but leaves the current document URL untouched.

Exporting

For exporting purposes, a filter name can be passed to storeAsURL() and storeToURL() that triggers an export to other file formats. The property needed for this purpose is the string argument FilterName that takes filter names defined in the configuration file:

  <OfficePath>\share\config\registry\instance\org\openoffice\Office\TypeDetection.xml
</source>
In ''TypeDetection.xml'', look for <code><Filter/></code> elements, their <code>cfg:name</code> attribute contains the needed strings for <code>FilterName</code>. The proper filter name for StarWriter 5.x is "StarWriter 5.0", and the export format "MS Word 97" is also popular. This is the element in ''TypeDetection.xml'' that describes the MS Word 97 filter:
<source lang="xml">
  <Filter cfg:name="MS Word 97">
     <Installed cfg:type="boolean">true</Installed> 
     <UIName cfg:type="string" cfg:localized="true">
       <cfg:value xml:lang="en-US">Microsoft Word 97/2000/XP</cfg:value> 
     </UIName>
     <Data cfg:type="string">3,writer_MS_Word_97,com.sun.star.text.TextDocument,,67,CWW8,0,,</Data> 
  </Filter>

The following method stores a document using this filter:

  /** Store a document, using the MS Word 97/2000/XP Filter */
      protected void storeDocComponent(XComponent xDoc, String storeUrl) throws java.lang.Exception {
  
          XStorable xStorable = (XStorable)UnoRuntime.queryInterface(XStorable.class, xDoc);
          PropertyValue[] storeProps = new PropertyValue[1];
          storeProps[0] = new PropertyValue();
          storeProps[0].Name = "FilterName";
          storeProps[0].Value = "MS Word 97"; 
          xStorable.storeAsURL(storeUrl, storeProps); 
      }

If an empty array of PropertyValue structs is passed, the native .odt format of Apache OpenOffice is used.

Content on this page is licensed under the Public Documentation License (PDL).