com.aspose.words

Class FieldDocVariable

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldDocVariable

public class FieldDocVariable
extends Field

Implements DOCVARIABLE field.

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

Examples:

Shows how to use DOCPROPERTY fields to display document properties and variables.

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

 // Below are two ways of using DOCPROPERTY fields.
 // 1 -  Display a built-in property:
 // Set a custom value for the "Category" built-in property, then insert a DOCPROPERTY field that references it.
 doc.getBuiltInDocumentProperties().setCategory("My category");

 FieldDocProperty fieldDocProperty = (FieldDocProperty) builder.insertField(" DOCPROPERTY Category ");
 fieldDocProperty.update();

 Assert.assertEquals(fieldDocProperty.getFieldCode(), " DOCPROPERTY Category ");
 Assert.assertEquals(fieldDocProperty.getResult(), "My category");

 builder.insertParagraph();

 // 2 -  Display a custom document variable:
 // Define a custom variable, then reference that variable with a DOCPROPERTY field.
 Assert.assertTrue(doc.getVariables().getCount() == 0);
 doc.getVariables().add("My variable", "My variable's value");

 FieldDocVariable fieldDocVariable = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
 fieldDocVariable.setVariableName("My Variable");
 fieldDocVariable.update();

 Assert.assertEquals(" DOCVARIABLE  \"My Variable\"", fieldDocVariable.getFieldCode());
 Assert.assertEquals("My variable's value", fieldDocVariable.getResult());

 doc.save(getArtifactsDir() + "Field.DOCPROPERTY.DOCVARIABLE.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getVariableName() Gets the name of the document variable to retrieve.
void	setVariableName(java.lang.String value) Sets the name of the document variable to retrieve.

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

getVariableName

public java.lang.String getVariableName()

Gets the name of the document variable to retrieve.

Examples:

Shows how to use DOCPROPERTY fields to display document properties and variables.

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

 // Below are two ways of using DOCPROPERTY fields.
 // 1 -  Display a built-in property:
 // Set a custom value for the "Category" built-in property, then insert a DOCPROPERTY field that references it.
 doc.getBuiltInDocumentProperties().setCategory("My category");

 FieldDocProperty fieldDocProperty = (FieldDocProperty) builder.insertField(" DOCPROPERTY Category ");
 fieldDocProperty.update();

 Assert.assertEquals(fieldDocProperty.getFieldCode(), " DOCPROPERTY Category ");
 Assert.assertEquals(fieldDocProperty.getResult(), "My category");

 builder.insertParagraph();

 // 2 -  Display a custom document variable:
 // Define a custom variable, then reference that variable with a DOCPROPERTY field.
 Assert.assertTrue(doc.getVariables().getCount() == 0);
 doc.getVariables().add("My variable", "My variable's value");

 FieldDocVariable fieldDocVariable = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
 fieldDocVariable.setVariableName("My Variable");
 fieldDocVariable.update();

 Assert.assertEquals(" DOCVARIABLE  \"My Variable\"", fieldDocVariable.getFieldCode());
 Assert.assertEquals("My variable's value", fieldDocVariable.getResult());

 doc.save(getArtifactsDir() + "Field.DOCPROPERTY.DOCVARIABLE.docx");
 
 

Returns:

The name of the document variable to retrieve.

setVariableName

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

Sets the name of the document variable to retrieve.

Examples:

Shows how to use DOCPROPERTY fields to display document properties and variables.

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

 // Below are two ways of using DOCPROPERTY fields.
 // 1 -  Display a built-in property:
 // Set a custom value for the "Category" built-in property, then insert a DOCPROPERTY field that references it.
 doc.getBuiltInDocumentProperties().setCategory("My category");

 FieldDocProperty fieldDocProperty = (FieldDocProperty) builder.insertField(" DOCPROPERTY Category ");
 fieldDocProperty.update();

 Assert.assertEquals(fieldDocProperty.getFieldCode(), " DOCPROPERTY Category ");
 Assert.assertEquals(fieldDocProperty.getResult(), "My category");

 builder.insertParagraph();

 // 2 -  Display a custom document variable:
 // Define a custom variable, then reference that variable with a DOCPROPERTY field.
 Assert.assertTrue(doc.getVariables().getCount() == 0);
 doc.getVariables().add("My variable", "My variable's value");

 FieldDocVariable fieldDocVariable = (FieldDocVariable) builder.insertField(FieldType.FIELD_DOC_VARIABLE, true);
 fieldDocVariable.setVariableName("My Variable");
 fieldDocVariable.update();

 Assert.assertEquals(" DOCVARIABLE  \"My Variable\"", fieldDocVariable.getFieldCode());
 Assert.assertEquals("My variable's value", fieldDocVariable.getResult());

 doc.save(getArtifactsDir() + "Field.DOCPROPERTY.DOCVARIABLE.docx");
 
 

Parameters:

value - The name of the document variable to retrieve.

Throws:

java.lang.Exception