com.aspose.words
Class FieldRef

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

public class FieldRef 
extends Field

Implements the REF field. Inserts the text or graphics represented by the specified bookmark.

Constructor Summary
FieldRef()
          
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
voidsetBookmarkName(java.lang.String value)
           Gets or sets the referenced bookmark's name.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleangetIncludeNoteOrComment()
voidsetIncludeNoteOrComment(boolean value)
           Gets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
booleangetInsertHyperlink()
voidsetInsertHyperlink(boolean value)
           Gets or sets whether to create a hyperlink to the bookmarked paragraph.
booleangetInsertParagraphNumber()
voidsetInsertParagraphNumber(boolean value)
           Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
booleangetInsertParagraphNumberInFullContext()
voidsetInsertParagraphNumberInFullContext(boolean value)
           Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.
booleangetInsertParagraphNumberInRelativeContext()
voidsetInsertParagraphNumberInRelativeContext(boolean value)
           Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
booleangetInsertRelativePosition()
voidsetInsertRelativePosition(boolean value)
           Gets or sets whether to insert the relative position of the referenced paragraph.
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)
          
java.lang.StringgetNumberSeparator()
voidsetNumberSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
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.
booleangetSuppressNonDelimiters()
voidsetSuppressNonDelimiters(boolean value)
           Gets or sets whether to suppress non-delimiter characters.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
booleancanWorkAsMergeField()
          Reserved for internal use.
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).
java.lang.StringgetMergeFieldName()
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
booleanisMergeValueRequired()
          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

FieldRef

public FieldRef()

Property Getters/Setters Detail

getBookmarkName/setBookmarkName

public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value)
Gets or sets the referenced bookmark's name.

getEnd

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

getFormat

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

getIncludeNoteOrComment/setIncludeNoteOrComment

public boolean getIncludeNoteOrComment() / public void setIncludeNoteOrComment(boolean value)
Gets or sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.

getInsertHyperlink/setInsertHyperlink

public boolean getInsertHyperlink() / public void setInsertHyperlink(boolean value)
Gets or sets whether to create a hyperlink to the bookmarked paragraph.

getInsertParagraphNumber/setInsertParagraphNumber

public boolean getInsertParagraphNumber() / public void setInsertParagraphNumber(boolean value)
Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.

getInsertParagraphNumberInFullContext/setInsertParagraphNumberInFullContext

public boolean getInsertParagraphNumberInFullContext() / public void setInsertParagraphNumberInFullContext(boolean value)
Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.

getInsertParagraphNumberInRelativeContext/setInsertParagraphNumberInRelativeContext

public boolean getInsertParagraphNumberInRelativeContext() / public void setInsertParagraphNumberInRelativeContext(boolean value)
Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.

getInsertRelativePosition/setInsertRelativePosition

public boolean getInsertRelativePosition() / public void setInsertRelativePosition(boolean value)
Gets or sets whether to insert the relative position of the referenced paragraph.

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)

getNumberSeparator/setNumberSeparator

public java.lang.String getNumberSeparator() / public void setNumberSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate sequence numbers and page numbers.

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.

getSuppressNonDelimiters/setSuppressNonDelimiters

public boolean getSuppressNonDelimiters() / public void setSuppressNonDelimiters(boolean value)
Gets or sets whether to suppress non-delimiter characters.

getType

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

Method Detail

canWorkAsMergeField

public boolean canWorkAsMergeField()
Reserved for internal use.

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.

getMergeFieldName

public java.lang.String getMergeFieldName()
Reserved for internal use.

getSwitchType

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

isMergeValueRequired

public boolean isMergeValueRequired()
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.