com.aspose.words

Class FieldInfo

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldInfo

public class FieldInfo
extends Field

Implements the INFO field.

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

Remarks:

Inserts information about a document property.

Examples:

Shows how to work with INFO fields.

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

 // Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
 doc.getBuiltInDocumentProperties().setComments("My comment");
 FieldInfo field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.update();

 Assert.assertEquals(field.getFieldCode(), " INFO  Comments");
 Assert.assertEquals(field.getResult(), "My comment");

 builder.writeln();

 // Setting a value for the field's NewValue property and updating
 // the field will also overwrite the corresponding built-in property with the new value.
 field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.setNewValue("New comment");
 field.update();

 Assert.assertEquals(" INFO  Comments \"New comment\"", field.getFieldCode());
 Assert.assertEquals("New comment", field.getResult());
 Assert.assertEquals("New comment", doc.getBuiltInDocumentProperties().getComments());

 doc.save(getArtifactsDir() + "Field.INFO.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInfoType() Gets the type of the document property to insert.
java.lang.String	getNewValue() Gets an optional value that updates the property.
int	getSwitchType(java.lang.String switchName)
void	setInfoType(java.lang.String value) Sets the type of the document property to insert.
void	setNewValue(java.lang.String value) Sets an optional value that updates the property.

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

getInfoType

public java.lang.String getInfoType()

Gets the type of the document property to insert.

Examples:

Shows how to work with INFO fields.

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

 // Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
 doc.getBuiltInDocumentProperties().setComments("My comment");
 FieldInfo field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.update();

 Assert.assertEquals(field.getFieldCode(), " INFO  Comments");
 Assert.assertEquals(field.getResult(), "My comment");

 builder.writeln();

 // Setting a value for the field's NewValue property and updating
 // the field will also overwrite the corresponding built-in property with the new value.
 field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.setNewValue("New comment");
 field.update();

 Assert.assertEquals(" INFO  Comments \"New comment\"", field.getFieldCode());
 Assert.assertEquals("New comment", field.getResult());
 Assert.assertEquals("New comment", doc.getBuiltInDocumentProperties().getComments());

 doc.save(getArtifactsDir() + "Field.INFO.docx");
 
 

Returns:

The type of the document property to insert.

setInfoType

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

Sets the type of the document property to insert.

Examples:

Shows how to work with INFO fields.

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

 // Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
 doc.getBuiltInDocumentProperties().setComments("My comment");
 FieldInfo field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.update();

 Assert.assertEquals(field.getFieldCode(), " INFO  Comments");
 Assert.assertEquals(field.getResult(), "My comment");

 builder.writeln();

 // Setting a value for the field's NewValue property and updating
 // the field will also overwrite the corresponding built-in property with the new value.
 field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.setNewValue("New comment");
 field.update();

 Assert.assertEquals(" INFO  Comments \"New comment\"", field.getFieldCode());
 Assert.assertEquals("New comment", field.getResult());
 Assert.assertEquals("New comment", doc.getBuiltInDocumentProperties().getComments());

 doc.save(getArtifactsDir() + "Field.INFO.docx");
 
 

Parameters:

value - The type of the document property to insert.

Throws:

java.lang.Exception

getNewValue

public java.lang.String getNewValue()

Gets an optional value that updates the property.

Examples:

Shows how to work with INFO fields.

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

 // Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
 doc.getBuiltInDocumentProperties().setComments("My comment");
 FieldInfo field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.update();

 Assert.assertEquals(field.getFieldCode(), " INFO  Comments");
 Assert.assertEquals(field.getResult(), "My comment");

 builder.writeln();

 // Setting a value for the field's NewValue property and updating
 // the field will also overwrite the corresponding built-in property with the new value.
 field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.setNewValue("New comment");
 field.update();

 Assert.assertEquals(" INFO  Comments \"New comment\"", field.getFieldCode());
 Assert.assertEquals("New comment", field.getResult());
 Assert.assertEquals("New comment", doc.getBuiltInDocumentProperties().getComments());

 doc.save(getArtifactsDir() + "Field.INFO.docx");
 
 

Returns:

An optional value that updates the property.

setNewValue

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

Sets an optional value that updates the property.

Examples:

Shows how to work with INFO fields.

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

 // Set a value for the "Comments" built-in property and then insert an INFO field to display that property's value.
 doc.getBuiltInDocumentProperties().setComments("My comment");
 FieldInfo field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.update();

 Assert.assertEquals(field.getFieldCode(), " INFO  Comments");
 Assert.assertEquals(field.getResult(), "My comment");

 builder.writeln();

 // Setting a value for the field's NewValue property and updating
 // the field will also overwrite the corresponding built-in property with the new value.
 field = (FieldInfo) builder.insertField(FieldType.FIELD_INFO, true);
 field.setInfoType("Comments");
 field.setNewValue("New comment");
 field.update();

 Assert.assertEquals(" INFO  Comments \"New comment\"", field.getFieldCode());
 Assert.assertEquals("New comment", field.getResult());
 Assert.assertEquals("New comment", doc.getBuiltInDocumentProperties().getComments());

 doc.save(getArtifactsDir() + "Field.INFO.docx");
 
 

Parameters:

value - An optional value that updates the property.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)