Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: text ::

interface XDependentTextField
Base Interfaces
XDependentTextFieldXTextFieldXTextContent
      ┗ ::com::sun::star::lang::XComponent

XTextField
(referenced interface's summary:)
is the base interface for all text fields.
Description
makes it possible to attach this TextField to a TextFieldMaster.

Methods' Summary
attachTextFieldMaster method must be called to attach the TextFieldMaster to this TextField.  
getTextFieldMaster  
Methods' Details
attachTextFieldMaster
void
attachTextFieldMaster( [in] ::com::sun::star::beans::XPropertySet  xFieldMaster )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
method must be called to attach the TextFieldMaster to this TextField.

A TextFieldMaster can only be assigned once.

Example
Create and insert a user field (with a UserField):
 // Create a fieldmaster for our newly created User Text field, and access it's
 // XPropertySet interface
 XPropertySet xMasterPropSet = (XPropertySet) UnoRuntime.queryInterface( 
 XPropertySet.class, mxDocFactory.createInstance(
 "com.sun.star.text.FieldMaster.User"));
 // Set the name and value of the FieldMaster
 xMasterPropSet.setPropertyValue ("Name", "UserEmperor");
 xMasterPropSet.setPropertyValue ("Value", new Integer(42));
 // Attach the field master to the user field
 xUserField.attachTextFieldMaster (xMasterPropSet);
 // Move the cursor to the end of the document
 mxDocCursor.gotoEnd(false);
 // insert a paragraph break using the XSimpleText interface
 mxDocText.insertControlCharacter(
 mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false);
 // Insert the user field at the end of the document
 mxDocText.insertTextContent(mxDocText.getEnd(), xUserField, false);
 
getTextFieldMaster
::com::sun::star::beans::XPropertySet
getTextFieldMaster();

Returns
the previously attached TextFieldMaster
Top of Page

Apache Software Foundation

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

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