com.aspose.words

Class FieldRD

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldRD

public class FieldRD
extends Field

Implements the RD field.

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

Remarks:

Identifies a file to include when you create a table of contents, a table of authorities, or an index with the TOC, TOA, or INDEX field

Examples:

Shows to use the RD field to create a table of contents entries from headings in other documents.

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

 // Use a document builder to insert a table of contents,
 // and then add one entry for the table of contents on the following page.
 builder.insertField(FieldType.FIELD_TOC, true);
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 builder.writeln("TOC entry from within this document");

 // Insert an RD field, which references another local file system document in its FileName property.
 // The TOC will also now accept all headings from the referenced document as entries for its table.
 FieldRD field = (FieldRD) builder.insertField(FieldType.FIELD_REF_DOC, true);
 field.setFileName("ReferencedDocument.docx");
 field.isPathRelative(true);

 Assert.assertEquals(field.getFieldCode(), " RD  ReferencedDocument.docx \\f");

 // Create the document that the RD field is referencing and insert a heading.
 // This heading will show up as an entry in the TOC field in our first document.
 Document referencedDoc = new Document();
 DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
 refDocBuilder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 refDocBuilder.writeln("TOC entry from referenced document");
 referencedDoc.save(getArtifactsDir() + "ReferencedDocument.docx");

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFileName() Gets the name of the file to include when generating a table of contents, table of authorities, or index.
int	getSwitchType(java.lang.String switchName)
boolean	isPathRelative() Gets whether the path is relative to the current document.
void	isPathRelative(boolean value) Sets whether the path is relative to the current document.
void	setFileName(java.lang.String value) Sets the name of the file to include when generating a table of contents, table of authorities, or index.

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

getFileName

public java.lang.String getFileName()

Gets the name of the file to include when generating a table of contents, table of authorities, or index.

Examples:

Shows to use the RD field to create a table of contents entries from headings in other documents.

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

 // Use a document builder to insert a table of contents,
 // and then add one entry for the table of contents on the following page.
 builder.insertField(FieldType.FIELD_TOC, true);
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 builder.writeln("TOC entry from within this document");

 // Insert an RD field, which references another local file system document in its FileName property.
 // The TOC will also now accept all headings from the referenced document as entries for its table.
 FieldRD field = (FieldRD) builder.insertField(FieldType.FIELD_REF_DOC, true);
 field.setFileName("ReferencedDocument.docx");
 field.isPathRelative(true);

 Assert.assertEquals(field.getFieldCode(), " RD  ReferencedDocument.docx \\f");

 // Create the document that the RD field is referencing and insert a heading.
 // This heading will show up as an entry in the TOC field in our first document.
 Document referencedDoc = new Document();
 DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
 refDocBuilder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 refDocBuilder.writeln("TOC entry from referenced document");
 referencedDoc.save(getArtifactsDir() + "ReferencedDocument.docx");

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

Returns:

The name of the file to include when generating a table of contents, table of authorities, or index.

setFileName

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

Sets the name of the file to include when generating a table of contents, table of authorities, or index.

Examples:

Shows to use the RD field to create a table of contents entries from headings in other documents.

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

 // Use a document builder to insert a table of contents,
 // and then add one entry for the table of contents on the following page.
 builder.insertField(FieldType.FIELD_TOC, true);
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 builder.writeln("TOC entry from within this document");

 // Insert an RD field, which references another local file system document in its FileName property.
 // The TOC will also now accept all headings from the referenced document as entries for its table.
 FieldRD field = (FieldRD) builder.insertField(FieldType.FIELD_REF_DOC, true);
 field.setFileName("ReferencedDocument.docx");
 field.isPathRelative(true);

 Assert.assertEquals(field.getFieldCode(), " RD  ReferencedDocument.docx \\f");

 // Create the document that the RD field is referencing and insert a heading.
 // This heading will show up as an entry in the TOC field in our first document.
 Document referencedDoc = new Document();
 DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
 refDocBuilder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 refDocBuilder.writeln("TOC entry from referenced document");
 referencedDoc.save(getArtifactsDir() + "ReferencedDocument.docx");

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

Parameters:

value - The name of the file to include when generating a table of contents, table of authorities, or index.

Throws:

java.lang.Exception

isPathRelative

public boolean isPathRelative()

Gets whether the path is relative to the current document.

Examples:

Shows to use the RD field to create a table of contents entries from headings in other documents.

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

 // Use a document builder to insert a table of contents,
 // and then add one entry for the table of contents on the following page.
 builder.insertField(FieldType.FIELD_TOC, true);
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 builder.writeln("TOC entry from within this document");

 // Insert an RD field, which references another local file system document in its FileName property.
 // The TOC will also now accept all headings from the referenced document as entries for its table.
 FieldRD field = (FieldRD) builder.insertField(FieldType.FIELD_REF_DOC, true);
 field.setFileName("ReferencedDocument.docx");
 field.isPathRelative(true);

 Assert.assertEquals(field.getFieldCode(), " RD  ReferencedDocument.docx \\f");

 // Create the document that the RD field is referencing and insert a heading.
 // This heading will show up as an entry in the TOC field in our first document.
 Document referencedDoc = new Document();
 DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
 refDocBuilder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 refDocBuilder.writeln("TOC entry from referenced document");
 referencedDoc.save(getArtifactsDir() + "ReferencedDocument.docx");

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

Returns:

Whether the path is relative to the current document.

isPathRelative

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

Sets whether the path is relative to the current document.

Examples:

Shows to use the RD field to create a table of contents entries from headings in other documents.

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

 // Use a document builder to insert a table of contents,
 // and then add one entry for the table of contents on the following page.
 builder.insertField(FieldType.FIELD_TOC, true);
 builder.insertBreak(BreakType.PAGE_BREAK);
 builder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 builder.writeln("TOC entry from within this document");

 // Insert an RD field, which references another local file system document in its FileName property.
 // The TOC will also now accept all headings from the referenced document as entries for its table.
 FieldRD field = (FieldRD) builder.insertField(FieldType.FIELD_REF_DOC, true);
 field.setFileName("ReferencedDocument.docx");
 field.isPathRelative(true);

 Assert.assertEquals(field.getFieldCode(), " RD  ReferencedDocument.docx \\f");

 // Create the document that the RD field is referencing and insert a heading.
 // This heading will show up as an entry in the TOC field in our first document.
 Document referencedDoc = new Document();
 DocumentBuilder refDocBuilder = new DocumentBuilder(referencedDoc);
 refDocBuilder.getCurrentParagraph().getParagraphFormat().setStyleName("Heading 1");
 refDocBuilder.writeln("TOC entry from referenced document");
 referencedDoc.save(getArtifactsDir() + "ReferencedDocument.docx");

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

Parameters:

value - Whether the path is relative to the current document.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)