Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: text ::
interface XDependentTextField
  Base Interfaces
      XDependentTextField
      ┗ XTextField
         ┗ XTextContent
            ┗ ::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

Copyright © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.