com.aspose.words

Class FieldIncludeText

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldIncludeText

public class FieldIncludeText
extends Field

Implements the INCLUDETEXT 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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBookmarkName() Gets the name of the bookmark in the document to include.
java.lang.String	getEncoding() Gets the encoding applied to the data within the referenced file.
boolean	getLockFields() Gets whether to prevent fields in the included document from being updated.
java.lang.String	getMimeType() Gets the MIME type of the referenced file.
java.lang.String	getNamespaceMappings() Gets the namespace mappings for XPath queries.
java.lang.String	getSourceFullName() Gets the location of the document using an IRI.
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() Gets XPath for the desired portion of the XML file.
java.lang.String	getXslTransformation() Gets the location of XSL Transformation to format XML data.
void	setBookmarkName(java.lang.String value) Sets the name of the bookmark in the document to include.
void	setEncoding(java.lang.String value) Sets the encoding applied to the data within the referenced file.
void	setLockFields(boolean value) Sets whether to prevent fields in the included document from being updated.
void	setMimeType(java.lang.String value) Sets the MIME type of the referenced file.
void	setNamespaceMappings(java.lang.String value) Sets the namespace mappings for XPath queries.
void	setSourceFullName(java.lang.String value) Sets the location of the document using an IRI.
void	setTextConverter(java.lang.String value) Sets the name of the text converter for the format of the included file.
void	setXPath(java.lang.String value) Sets XPath for the desired portion of the XML file.
void	setXslTransformation(java.lang.String value) Sets the location of XSL Transformation to format XML data.

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 using an IRI.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

The location of the document using an IRI.

setSourceFullName

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

Sets the location of the document using an IRI.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - The location of the document using an IRI.

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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 INCLUDETEXT field, and set its properties.

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

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()

Gets the namespace mappings for XPath queries.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

The namespace mappings for XPath queries.

setNamespaceMappings

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

Sets the namespace mappings for XPath queries.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - The namespace mappings for XPath queries.

Throws:

java.lang.Exception

getXslTransformation

public java.lang.String getXslTransformation()

Gets the location of XSL Transformation to format XML data.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

The location of XSL Transformation to format XML data.

setXslTransformation

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

Sets the location of XSL Transformation to format XML data.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - The location of XSL Transformation to format XML data.

Throws:

java.lang.Exception

getXPath

public java.lang.String getXPath()

Gets XPath for the desired portion of the XML file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

XPath for the desired portion of the XML file.

setXPath

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

Sets XPath for the desired portion of the XML file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - XPath for the desired portion of the XML file.

Throws:

java.lang.Exception

getEncoding

public java.lang.String getEncoding()

Gets the encoding applied to the data within the referenced file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

The encoding applied to the data within the referenced file.

setEncoding

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

Sets the encoding applied to the data within the referenced file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - The encoding applied to the data within the referenced file.

Throws:

java.lang.Exception

getMimeType

public java.lang.String getMimeType()

Gets the MIME type of the referenced file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Returns:

The MIME type of the referenced file.

setMimeType

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

Sets the MIME type of the referenced file.

Examples:

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

 
 public void fieldIncludeText() throws Exception {
     Document doc = new Document();
     DocumentBuilder builder = new DocumentBuilder(doc);

     // Below are two ways to use INCLUDETEXT fields to display the contents of an XML file in the local file system.
     // 1 -  Perform an XSL transformation on an XML document:
     FieldIncludeText fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setXslTransformation(getMyDir() + "CD collection XSL transformation.xsl");

     builder.writeln();

     // 2 -  Use an XPath to take specific elements from an XML document:
     fieldIncludeText = createFieldIncludeText(builder, getMyDir() + "CD collection data.xml", false, "text/xml", "XML", "ISO-8859-1");
     fieldIncludeText.setNamespaceMappings("xmlns:n='myNamespace'");
     fieldIncludeText.setXPath("/catalog/cd/title");

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

 /// <summary>
 /// Use a document builder to insert an INCLUDETEXT field with custom properties.
 /// </summary>
 public FieldIncludeText createFieldIncludeText(DocumentBuilder builder, String sourceFullName, boolean lockFields, String mimeType, String textConverter, String encoding) throws Exception {
     FieldIncludeText fieldIncludeText = (FieldIncludeText) builder.insertField(FieldType.FIELD_INCLUDE_TEXT, true);
     fieldIncludeText.setSourceFullName(sourceFullName);
     fieldIncludeText.setLockFields(lockFields);
     fieldIncludeText.setMimeType(mimeType);
     fieldIncludeText.setTextConverter(textConverter);
     fieldIncludeText.setEncoding(encoding);

     return fieldIncludeText;
 }
 
 

Parameters:

value - The MIME type of the referenced file.

Throws:

java.lang.Exception

getSourceFullNameArgumentIndex

public int getSourceFullNameArgumentIndex()

getSwitchType

public int getSwitchType(java.lang.String switchName)