com.aspose.words
Class FieldXE

java.lang.Object
  extended by Field
      extended by com.aspose.words.FieldXE

public class FieldXE 
extends Field

Implements the XE field. Defines the text and page number for an index entry, which is used by an INDEX field.

Constructor Summary
FieldXE()
          
 
Property Getters/Setters Summary
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetEntryType()
voidsetEntryType(java.lang.String value)
           Gets or sets an index entry type.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleanhasPageRangeBookmarkName()
           Gets a value indicating whether a page range bookmark name is provided through the field's code.
booleanisBold()
voidisBold(boolean value)
           Gets or sets whether to apply bold formatting to the entry's page number.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
          
booleanisItalic()
voidisItalic(boolean value)
           Gets or sets whether to apply italic formatting to the entry's page number.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
java.lang.StringgetPageNumberReplacement()
voidsetPageNumberReplacement(java.lang.String value)
           Gets or sets text used in place of a page number.
java.lang.StringgetPageRangeBookmarkName()
voidsetPageRangeBookmarkName(java.lang.String value)
           Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text of the entry.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
java.lang.StringgetYomi()
voidsetYomi(java.lang.String value)
           Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
Aspose.Words.Noderemove()→ inherited from Field
           Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldXE

public FieldXE()

Property Getters/Setters Detail

getEnd

→ inherited from Field
public FieldEnd getEnd()
Gets the node that represents the field end.

getEntryType/setEntryType

public java.lang.String getEntryType() / public void setEntryType(java.lang.String value)
Gets or sets an index entry type.

getFormat

→ inherited from Field
public FieldFormat getFormat()
Gets a FieldFormat object that provides typed access to field's formatting.

hasPageRangeBookmarkName

public boolean hasPageRangeBookmarkName()
Gets a value indicating whether a page range bookmark name is provided through the field's code.

isBold/isBold

public boolean isBold() / public void isBold(boolean value)
Gets or sets whether to apply bold formatting to the entry's page number.

isDirty/isDirty

→ inherited from Field
public boolean isDirty() / public void isDirty(boolean value)

isItalic/isItalic

public boolean isItalic() / public void isItalic(boolean value)
Gets or sets whether to apply italic formatting to the entry's page number.

isLocked/isLocked

→ inherited from Field
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the field is locked (should not recalculate its result).

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)
Gets or sets the LCID of the field.
See Also:
FieldUpdateCultureSource.FIELD_CODE

getPageNumberReplacement/setPageNumberReplacement

public java.lang.String getPageNumberReplacement() / public void setPageNumberReplacement(java.lang.String value)
Gets or sets text used in place of a page number.

getPageRangeBookmarkName/setPageRangeBookmarkName

public java.lang.String getPageRangeBookmarkName() / public void setPageRangeBookmarkName(java.lang.String value)
Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.

getResult/setResult

→ inherited from Field
public java.lang.String getResult() / public void setResult(java.lang.String value)
Gets or sets text that is between the field separator and field end.

getSeparator

→ inherited from Field
public FieldSeparator getSeparator()
Gets the node that represents the field separator. Can be null.

getStart

→ inherited from Field
public FieldStart getStart()
Gets the node that represents the start of the field.

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Gets or sets the text of the entry.

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

getYomi/setYomi

public java.lang.String getYomi() / public void setYomi(java.lang.String value)
Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

getSwitchType

public aspose.obfuscated.type getSwitchType(java.lang.String switchName)
Reserved for internal use.

remove

→ inherited from Field
public Aspose.Words.Node remove()
           throws java.lang.Exception
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Returns:
True if the field has been unlinked, otherwise false.

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.