FieldRef (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Field
- - com.aspose.words.FieldRef

```
public class FieldRef
extends Field
```
Implements the REF field. Inserts the text or graphics represented by the specified bookmark.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canWorkAsMergeField()`
`java.lang.String`	`getBookmarkName()` Gets the referenced bookmark's name.
`boolean`	`getIncludeNoteOrComment()` Gets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
`boolean`	`getInsertHyperlink()` Gets whether to create a hyperlink to the bookmarked paragraph.
`boolean`	`getInsertParagraphNumber()` Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
`boolean`	`getInsertParagraphNumberInFullContext()` Gets whether to insert the paragraph number of the referenced paragraph in full context.
`boolean`	`getInsertParagraphNumberInRelativeContext()` Gets whether to insert the paragraph number of the referenced paragraph in relative context.
`boolean`	`getInsertRelativePosition()` Gets whether to insert the relative position of the referenced paragraph.
`java.lang.String`	`getMergeFieldName()`
`java.lang.String`	`getNumberSeparator()` Gets the character sequence that is used to separate sequence numbers and page numbers.
`boolean`	`getSuppressNonDelimiters()` Gets whether to suppress non-delimiter characters.
`int`	`getSwitchType(java.lang.String switchName)`
`boolean`	`isMergeValueRequired()`
`void`	`setBookmarkName(java.lang.String value)` Sets the referenced bookmark's name.
`void`	`setIncludeNoteOrComment(boolean value)` Sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
`void`	`setInsertHyperlink(boolean value)` Sets whether to create a hyperlink to the bookmarked paragraph.
`void`	`setInsertParagraphNumber(boolean value)` Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
`void`	`setInsertParagraphNumberInFullContext(boolean value)` Sets whether to insert the paragraph number of the referenced paragraph in full context.
`void`	`setInsertParagraphNumberInRelativeContext(boolean value)` Sets whether to insert the paragraph number of the referenced paragraph in relative context.
`void`	`setInsertRelativePosition(boolean value)` Sets whether to insert the relative position of the referenced paragraph.
`void`	`setNumberSeparator(java.lang.String value)` Sets the character sequence that is used to separate sequence numbers and page numbers.
`void`	`setSuppressNonDelimiters(boolean value)` Sets whether to suppress non-delimiter characters.

Methods inherited from class com.aspose.words.Field
getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

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

- Method Detail
  - getSwitchType
```
public int getSwitchType(java.lang.String switchName)
```
  - getMergeFieldName
```
public java.lang.String getMergeFieldName()
```
  - canWorkAsMergeField
```
public boolean canWorkAsMergeField()
```
  - isMergeValueRequired
```
public boolean isMergeValueRequired()
```
  - getBookmarkName
```
public java.lang.String getBookmarkName()
```
    Gets the referenced bookmark's name.
    
    Returns:
    
    The referenced bookmark's name.
  - setBookmarkName
```
public void setBookmarkName(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the referenced bookmark's name.
    
    Parameters:
    
    value - The referenced bookmark's name.
    
    Throws:
    
    java.lang.Exception
  - getNumberSeparator
```
public java.lang.String getNumberSeparator()
```
    Gets the character sequence that is used to separate sequence numbers and page numbers.
    
    Returns:
    
    The character sequence that is used to separate sequence numbers and page numbers.
  - setNumberSeparator
```
public void setNumberSeparator(java.lang.String value)
                        throws java.lang.Exception
```
    Sets the character sequence that is used to separate sequence numbers and page numbers.
    
    Parameters:
    
    value - The character sequence that is used to separate sequence numbers and page numbers.
    
    Throws:
    
    java.lang.Exception
  - getIncludeNoteOrComment
```
public boolean getIncludeNoteOrComment()
```
    Gets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
    
    Returns:
    
    Whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
  - setIncludeNoteOrComment
```
public void setIncludeNoteOrComment(boolean value)
                             throws java.lang.Exception
```
    Sets whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
    
    Parameters:
    
    value - Whether to increment footnote, endnote, and annotation numbers that are marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
    
    Throws:
    
    java.lang.Exception
  - getInsertHyperlink
```
public boolean getInsertHyperlink()
```
    Gets whether to create a hyperlink to the bookmarked paragraph.
    
    Returns:
    
    Whether to create a hyperlink to the bookmarked paragraph.
  - setInsertHyperlink
```
public void setInsertHyperlink(boolean value)
                        throws java.lang.Exception
```
    Sets whether to create a hyperlink to the bookmarked paragraph.
    
    Parameters:
    
    value - Whether to create a hyperlink to the bookmarked paragraph.
    
    Throws:
    
    java.lang.Exception
  - getInsertParagraphNumber
```
public boolean getInsertParagraphNumber()
```
    Gets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
    
    Returns:
    
    Whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
  - setInsertParagraphNumber
```
public void setInsertParagraphNumber(boolean value)
                              throws java.lang.Exception
```
    Sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
    
    Parameters:
    
    value - Whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
    
    Throws:
    
    java.lang.Exception
  - getInsertRelativePosition
```
public boolean getInsertRelativePosition()
```
    Gets whether to insert the relative position of the referenced paragraph.
    
    Returns:
    
    Whether to insert the relative position of the referenced paragraph.
  - setInsertRelativePosition
```
public void setInsertRelativePosition(boolean value)
                               throws java.lang.Exception
```
    Sets whether to insert the relative position of the referenced paragraph.
    
    Parameters:
    
    value - Whether to insert the relative position of the referenced paragraph.
    
    Throws:
    
    java.lang.Exception
  - getInsertParagraphNumberInRelativeContext
```
public boolean getInsertParagraphNumberInRelativeContext()
```
    Gets whether to insert the paragraph number of the referenced paragraph in relative context.
    
    Returns:
    
    Whether to insert the paragraph number of the referenced paragraph in relative context.
  - setInsertParagraphNumberInRelativeContext
```
public void setInsertParagraphNumberInRelativeContext(boolean value)
                                               throws java.lang.Exception
```
    Sets whether to insert the paragraph number of the referenced paragraph in relative context.
    
    Parameters:
    
    value - Whether to insert the paragraph number of the referenced paragraph in relative context.
    
    Throws:
    
    java.lang.Exception
  - getSuppressNonDelimiters
```
public boolean getSuppressNonDelimiters()
```
    Gets whether to suppress non-delimiter characters.
    
    Returns:
    
    Whether to suppress non-delimiter characters.
  - setSuppressNonDelimiters
```
public void setSuppressNonDelimiters(boolean value)
                              throws java.lang.Exception
```
    Sets whether to suppress non-delimiter characters.
    
    Parameters:
    
    value - Whether to suppress non-delimiter characters.
    
    Throws:
    
    java.lang.Exception
  - getInsertParagraphNumberInFullContext
```
public boolean getInsertParagraphNumberInFullContext()
```
    Gets whether to insert the paragraph number of the referenced paragraph in full context.
    
    Returns:
    
    Whether to insert the paragraph number of the referenced paragraph in full context.
  - setInsertParagraphNumberInFullContext
```
public void setInsertParagraphNumberInFullContext(boolean value)
                                           throws java.lang.Exception
```
    Sets whether to insert the paragraph number of the referenced paragraph in full context.
    
    Parameters:
    
    value - Whether to insert the paragraph number of the referenced paragraph in full context.
    
    Throws:
    
    java.lang.Exception

Class FieldRef

Method Summary

Methods inherited from class com.aspose.words.Field

Methods inherited from class java.lang.Object

Method Detail

getSwitchType

getMergeFieldName

canWorkAsMergeField

isMergeValueRequired

getBookmarkName

setBookmarkName

getNumberSeparator

setNumberSeparator

getIncludeNoteOrComment

setIncludeNoteOrComment

getInsertHyperlink

setInsertHyperlink

getInsertParagraphNumber

setInsertParagraphNumber

getInsertRelativePosition

setInsertRelativePosition

getInsertParagraphNumberInRelativeContext

setInsertParagraphNumberInRelativeContext

getSuppressNonDelimiters

setSuppressNonDelimiters

getInsertParagraphNumberInFullContext

setInsertParagraphNumberInFullContext