com.aspose.words

Class FieldTemplate

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldTemplate

public class FieldTemplate
extends Field

Implements the TEMPLATE field.

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

Remarks:

Retrieves the file name of the template used by the current document.

Examples:

Shows how to use a TEMPLATE field to display the local file system location of a document's template.

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

 // We can set a template name using by the fields. This property is used when the "doc.AttachedTemplate" is empty.
 // If this property is empty the default template file name "Normal.dotm" is used.
 doc.getFieldOptions().setTemplateName("");

 FieldTemplate field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 Assert.assertEquals(field.getFieldCode(), " TEMPLATE ");

 builder.writeln();
 field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 field.setIncludeFullPath(true);

 Assert.assertEquals(field.getFieldCode(), " TEMPLATE  \\p");

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

Method Summary

Modifier and Type	Method and Description
boolean	getIncludeFullPath() Gets whether to include the full file path name.
int	getSwitchType(java.lang.String switchName)
void	setIncludeFullPath(boolean value) Sets whether to include the full file path name.

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

getIncludeFullPath

public boolean getIncludeFullPath()

Gets whether to include the full file path name.

Examples:

Shows how to use a TEMPLATE field to display the local file system location of a document's template.

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

 // We can set a template name using by the fields. This property is used when the "doc.AttachedTemplate" is empty.
 // If this property is empty the default template file name "Normal.dotm" is used.
 doc.getFieldOptions().setTemplateName("");

 FieldTemplate field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 Assert.assertEquals(field.getFieldCode(), " TEMPLATE ");

 builder.writeln();
 field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 field.setIncludeFullPath(true);

 Assert.assertEquals(field.getFieldCode(), " TEMPLATE  \\p");

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

Returns:

Whether to include the full file path name.

setIncludeFullPath

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

Sets whether to include the full file path name.

Examples:

Shows how to use a TEMPLATE field to display the local file system location of a document's template.

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

 // We can set a template name using by the fields. This property is used when the "doc.AttachedTemplate" is empty.
 // If this property is empty the default template file name "Normal.dotm" is used.
 doc.getFieldOptions().setTemplateName("");

 FieldTemplate field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 Assert.assertEquals(field.getFieldCode(), " TEMPLATE ");

 builder.writeln();
 field = (FieldTemplate) builder.insertField(FieldType.FIELD_TEMPLATE, false);
 field.setIncludeFullPath(true);

 Assert.assertEquals(field.getFieldCode(), " TEMPLATE  \\p");

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

Parameters:

value - Whether to include the full file path name.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)