com.aspose.words

Class FieldGoToButton

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldGoToButton

public class FieldGoToButton
extends Field

Implements the GOTOBUTTON field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Inserts a jump command, such that when it is activated, the insertion point of the document is moved to the specified location.

Examples:

Shows to insert a GOTOBUTTON field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
 // it will take the text cursor to the bookmark whose name the Location property references.
 FieldGoToButton field = (FieldGoToButton) builder.insertField(FieldType.FIELD_GO_TO_BUTTON, true);
 field.setDisplayText("My Button");
 field.setLocation("MyBookmark");

 Assert.assertEquals(field.getFieldCode(), " GOTOBUTTON  MyBookmark My Button");

 // Insert a valid bookmark for the field to reference.
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.startBookmark(field.getLocation());
 builder.writeln("Bookmark text contents.");
 builder.endBookmark(field.getLocation());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.GOTOBUTTON.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayText() Gets the text of the "button" that appears in the document, such that it can be selected to activate the jump.
java.lang.String	getLocation() Gets the name of a bookmark, a page number, or some other item to jump to.
void	setDisplayText(java.lang.String value) Sets the text of the "button" that appears in the document, such that it can be selected to activate the jump.
void	setLocation(java.lang.String value) Sets the name of a bookmark, a page number, or some other item to jump to.

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

getLocation

public java.lang.String getLocation()

Gets the name of a bookmark, a page number, or some other item to jump to.

Examples:

Shows to insert a GOTOBUTTON field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
 // it will take the text cursor to the bookmark whose name the Location property references.
 FieldGoToButton field = (FieldGoToButton) builder.insertField(FieldType.FIELD_GO_TO_BUTTON, true);
 field.setDisplayText("My Button");
 field.setLocation("MyBookmark");

 Assert.assertEquals(field.getFieldCode(), " GOTOBUTTON  MyBookmark My Button");

 // Insert a valid bookmark for the field to reference.
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.startBookmark(field.getLocation());
 builder.writeln("Bookmark text contents.");
 builder.endBookmark(field.getLocation());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.GOTOBUTTON.docx");
 
 

Returns:

The name of a bookmark, a page number, or some other item to jump to.

setLocation

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

Sets the name of a bookmark, a page number, or some other item to jump to.

Examples:

Shows to insert a GOTOBUTTON field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
 // it will take the text cursor to the bookmark whose name the Location property references.
 FieldGoToButton field = (FieldGoToButton) builder.insertField(FieldType.FIELD_GO_TO_BUTTON, true);
 field.setDisplayText("My Button");
 field.setLocation("MyBookmark");

 Assert.assertEquals(field.getFieldCode(), " GOTOBUTTON  MyBookmark My Button");

 // Insert a valid bookmark for the field to reference.
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.startBookmark(field.getLocation());
 builder.writeln("Bookmark text contents.");
 builder.endBookmark(field.getLocation());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.GOTOBUTTON.docx");
 
 

Parameters:

value - The name of a bookmark, a page number, or some other item to jump to.

Throws:

java.lang.Exception

getDisplayText

public java.lang.String getDisplayText()

Gets the text of the "button" that appears in the document, such that it can be selected to activate the jump.

Examples:

Shows to insert a GOTOBUTTON field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
 // it will take the text cursor to the bookmark whose name the Location property references.
 FieldGoToButton field = (FieldGoToButton) builder.insertField(FieldType.FIELD_GO_TO_BUTTON, true);
 field.setDisplayText("My Button");
 field.setLocation("MyBookmark");

 Assert.assertEquals(field.getFieldCode(), " GOTOBUTTON  MyBookmark My Button");

 // Insert a valid bookmark for the field to reference.
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.startBookmark(field.getLocation());
 builder.writeln("Bookmark text contents.");
 builder.endBookmark(field.getLocation());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.GOTOBUTTON.docx");
 
 

Returns:

The text of the "button" that appears in the document, such that it can be selected to activate the jump.

setDisplayText

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

Sets the text of the "button" that appears in the document, such that it can be selected to activate the jump.

Examples:

Shows to insert a GOTOBUTTON field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 // Add a GOTOBUTTON field. When we double-click this field in Microsoft Word,
 // it will take the text cursor to the bookmark whose name the Location property references.
 FieldGoToButton field = (FieldGoToButton) builder.insertField(FieldType.FIELD_GO_TO_BUTTON, true);
 field.setDisplayText("My Button");
 field.setLocation("MyBookmark");

 Assert.assertEquals(field.getFieldCode(), " GOTOBUTTON  MyBookmark My Button");

 // Insert a valid bookmark for the field to reference.
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.startBookmark(field.getLocation());
 builder.writeln("Bookmark text contents.");
 builder.endBookmark(field.getLocation());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.GOTOBUTTON.docx");
 
 

Parameters:

value - The text of the "button" that appears in the document, such that it can be selected to activate the jump.

Throws:

java.lang.Exception