com.aspose.words

Class FieldInclude

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldInclude

public class FieldInclude
extends Field

Implements the INCLUDE field.

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

Remarks:

Inserts all or part of the text and graphics contained in another document.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmarkName() Gets the name of the bookmark in the document to include.
boolean	getLockFields() Gets whether to prevent fields in the included document from being updated.
java.lang.String	getNamespaceMappings()
java.lang.String	getSourceFullName() Gets the location of the document.
int	getSourceFullNameArgumentIndex()
int	getSwitchType(java.lang.String switchName)
java.lang.String	getTextConverter() Gets the name of the text converter for the format of the included file.
java.lang.String	getXPath()
java.lang.String	getXslTransformation()
void	setBookmarkName(java.lang.String value) Sets the name of the bookmark in the document to include.
void	setLockFields(boolean value) Sets whether to prevent fields in the included document from being updated.
void	setSourceFullName(java.lang.String value) Sets the location of the document.
void	setTextConverter(java.lang.String value) Sets the name of the text converter for the format of the included file.

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

getSourceFullName

public java.lang.String getSourceFullName()

Gets the location of the document.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Returns:

The location of the document.

setSourceFullName

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

Sets the location of the document.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Parameters:

value - The location of the document.

Throws:

java.lang.Exception

getBookmarkName

public java.lang.String getBookmarkName()

Gets the name of the bookmark in the document to include.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Returns:

The name of the bookmark in the document to include.

setBookmarkName

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

Sets the name of the bookmark in the document to include.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Parameters:

value - The name of the bookmark in the document to include.

Throws:

java.lang.Exception

getLockFields

public boolean getLockFields()

Gets whether to prevent fields in the included document from being updated.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Returns:

Whether to prevent fields in the included document from being updated.

setLockFields

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

Sets whether to prevent fields in the included document from being updated.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Parameters:

value - Whether to prevent fields in the included document from being updated.

Throws:

java.lang.Exception

getTextConverter

public java.lang.String getTextConverter()

Gets the name of the text converter for the format of the included file.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Returns:

The name of the text converter for the format of the included file.

setTextConverter

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

Sets the name of the text converter for the format of the included file.

Examples:

Shows how to create an INCLUDE field, and set its properties.

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

 // We can use an INCLUDE field to import a portion of another document in the local file system.
 // The bookmark from the other document that we reference with this field contains this imported portion.
 FieldInclude field = (FieldInclude) builder.insertField(FieldType.FIELD_INCLUDE, true);
 field.setSourceFullName(getMyDir() + "Bookmarks.docx");
 field.setBookmarkName("MyBookmark1");
 field.setLockFields(false);
 field.setTextConverter("Microsoft Word");

 Assert.assertTrue(field.getFieldCode().matches(" INCLUDE .* MyBookmark1 \\\\c \"Microsoft Word\""));

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

Parameters:

value - The name of the text converter for the format of the included file.

Throws:

java.lang.Exception

getNamespaceMappings

public java.lang.String getNamespaceMappings()

getXPath

public java.lang.String getXPath()

getXslTransformation

public java.lang.String getXslTransformation()

getSourceFullNameArgumentIndex

public int getSourceFullNameArgumentIndex()

getSwitchType

public int getSwitchType(java.lang.String switchName)