Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.xwpf.usermodel
Class XWPFFieldRun

    java.lang.Object
      org.apache.poi.xwpf.usermodel.XWPFRun
          org.apache.poi.xwpf.usermodel.XWPFFieldRun

All Implemented Interfaces:
  CharacterRun, IRunElement, ISDTContents

    public class XWPFFieldRun

extends XWPFRun

A run of text which is part of a field, such as Title of Page number or Author. Any given Field may be made up of multiple of these.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.xwpf.usermodel.XWPFRun
`XWPFRun.FontCharRange`

Constructor Summary
`XWPFFieldRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField field, org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run, IRunBody p)`

Method Summary
`org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField` | `getCTField()`
`java.lang.String` | `getFieldInstruction()`
`void` | `setFieldInstruction(java.lang.String instruction)`

Methods inherited from class org.apache.poi.xwpf.usermodel.XWPFRun
`addBreak, addBreak, addBreak, addCarriageReturn, addPicture, addTab, getCharacterSpacing, getColor, getCTR, getDocument, getEmbeddedPictures, getFontFamily, getFontFamily, getFontName, getFontSize, getKerning, getParagraph, getParent, getPhonetic, getPictureText, getSubscript, getText, getTextPosition, getUnderline, isBold, isCapitalized, isDoubleStrikeThrough, isEmbossed, isHighlighted, isImprinted, isItalic, isShadowed, isSmallCaps, isStrike, isStrikeThrough, removeBreak, removeCarriageReturn, removeTab, setBold, setCapitalized, setCharacterSpacing, setColor, setDoubleStrikethrough, setEmbossed, setFontFamily, setFontFamily, setFontSize, setImprinted, setItalic, setKerning, setShadow, setSmallCaps, setStrike, setStrikeThrough, setSubscript, setText, setText, setTextPosition, setUnderline, text, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### XWPFFieldRun

    public XWPFFieldRun(org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField field,
                        org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR run,
                        IRunBody p)

Method Detail

### getCTField

    @Internal
    public org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField getCTField()

### getFieldInstruction

    public java.lang.String getFieldInstruction()

### setFieldInstruction

    public void setFieldInstruction(java.lang.String instruction)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.