com.aspose.words

Class FieldNoteRef

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldNoteRef

public class FieldNoteRef
extends Field

Implements the NOTEREF field. Inserts the mark of the footnote or endnote that is marked by the specified bookmark.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmarkName() Gets the name of the bookmark.
boolean	getInsertHyperlink() Gets whether to insert a hyperlink to the bookmarked paragraph.
boolean	getInsertReferenceMark() Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.
boolean	getInsertRelativePosition() Gets whether to insert a relative position of the bookmarked paragraph.
int	getSwitchType(java.lang.String switchName)
void	setBookmarkName(java.lang.String value) Sets the name of the bookmark.
void	setInsertHyperlink(boolean value) Sets whether to insert a hyperlink to the bookmarked paragraph.
void	setInsertReferenceMark(boolean value) Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.
void	setInsertRelativePosition(boolean value) Sets whether to insert a relative position of the bookmarked paragraph.

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

getBookmarkName

public java.lang.String getBookmarkName()

Gets the name of the bookmark.

Returns:

The name of the bookmark.

setBookmarkName

public void setBookmarkName(java.lang.String value)
                     throws java.lang.Exception

Sets the name of the bookmark.

Parameters:

value - The name of the bookmark.

Throws:

java.lang.Exception

getInsertReferenceMark

public boolean getInsertReferenceMark()

Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.

Returns:

The corresponding boolean value.

setInsertReferenceMark

public void setInsertReferenceMark(boolean value)
                            throws java.lang.Exception

Inserts the reference mark with the same character formatting as the Footnote Reference or Endnote Reference style.

Parameters:

value - The corresponding boolean value.

Throws:

java.lang.Exception

getInsertHyperlink

public boolean getInsertHyperlink()

Gets whether to insert a hyperlink to the bookmarked paragraph.

Returns:

Whether to insert a hyperlink to the bookmarked paragraph.

setInsertHyperlink

public void setInsertHyperlink(boolean value)
                        throws java.lang.Exception

Sets whether to insert a hyperlink to the bookmarked paragraph.

Parameters:

value - Whether to insert a hyperlink to the bookmarked paragraph.

Throws:

java.lang.Exception

getInsertRelativePosition

public boolean getInsertRelativePosition()

Gets whether to insert a relative position of the bookmarked paragraph.

Returns:

Whether to insert a relative position of the bookmarked paragraph.

setInsertRelativePosition

public void setInsertRelativePosition(boolean value)
                               throws java.lang.Exception

Sets whether to insert a relative position of the bookmarked paragraph.

Parameters:

value - Whether to insert a relative position of the bookmarked paragraph.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)