com.aspose.words

Class FieldUserAddress

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldUserAddress

public class FieldUserAddress
extends Field

Implements the USERADDRESS field.

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

Remarks:

Retrieves the current user's postal address.

Examples:

Shows how to use the USERADDRESS field.

 
 Document doc = new Document();

 // Create a UserInformation object and set it as the source of user information for any fields that we create.
 UserInformation userInformation = new UserInformation();
 userInformation.setAddress("123 Main Street");
 doc.getFieldOptions().setCurrentUser(userInformation);

 // Create a USERADDRESS field to display the current user's address,
 // taken from the UserInformation object we created above.
 DocumentBuilder builder = new DocumentBuilder(doc);
 FieldUserAddress fieldUserAddress = (FieldUserAddress) builder.insertField(FieldType.FIELD_USER_ADDRESS, true);
 Assert.assertEquals(" USERADDRESS ", fieldUserAddress.getFieldCode());
 Assert.assertEquals("123 Main Street", fieldUserAddress.getResult());

 // We can set this property to get our field to override the value currently stored in the UserInformation object.
 fieldUserAddress.setUserAddress("456 North Road");
 fieldUserAddress.update();

 Assert.assertEquals(" USERADDRESS  \"456 North Road\"", fieldUserAddress.getFieldCode());
 Assert.assertEquals("456 North Road", fieldUserAddress.getResult());

 // This does not affect the value in the UserInformation object.
 Assert.assertEquals("123 Main Street", doc.getFieldOptions().getCurrentUser().getAddress());

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUserAddress() Gets the current user's postal address.
void	setUserAddress(java.lang.String value) Sets the current user's postal address.

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

getUserAddress

public java.lang.String getUserAddress()

Gets the current user's postal address.

Examples:

Shows how to use the USERADDRESS field.

 
 Document doc = new Document();

 // Create a UserInformation object and set it as the source of user information for any fields that we create.
 UserInformation userInformation = new UserInformation();
 userInformation.setAddress("123 Main Street");
 doc.getFieldOptions().setCurrentUser(userInformation);

 // Create a USERADDRESS field to display the current user's address,
 // taken from the UserInformation object we created above.
 DocumentBuilder builder = new DocumentBuilder(doc);
 FieldUserAddress fieldUserAddress = (FieldUserAddress) builder.insertField(FieldType.FIELD_USER_ADDRESS, true);
 Assert.assertEquals(" USERADDRESS ", fieldUserAddress.getFieldCode());
 Assert.assertEquals("123 Main Street", fieldUserAddress.getResult());

 // We can set this property to get our field to override the value currently stored in the UserInformation object.
 fieldUserAddress.setUserAddress("456 North Road");
 fieldUserAddress.update();

 Assert.assertEquals(" USERADDRESS  \"456 North Road\"", fieldUserAddress.getFieldCode());
 Assert.assertEquals("456 North Road", fieldUserAddress.getResult());

 // This does not affect the value in the UserInformation object.
 Assert.assertEquals("123 Main Street", doc.getFieldOptions().getCurrentUser().getAddress());

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

Returns:

The current user's postal address.

setUserAddress

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

Sets the current user's postal address.

Examples:

Shows how to use the USERADDRESS field.

 
 Document doc = new Document();

 // Create a UserInformation object and set it as the source of user information for any fields that we create.
 UserInformation userInformation = new UserInformation();
 userInformation.setAddress("123 Main Street");
 doc.getFieldOptions().setCurrentUser(userInformation);

 // Create a USERADDRESS field to display the current user's address,
 // taken from the UserInformation object we created above.
 DocumentBuilder builder = new DocumentBuilder(doc);
 FieldUserAddress fieldUserAddress = (FieldUserAddress) builder.insertField(FieldType.FIELD_USER_ADDRESS, true);
 Assert.assertEquals(" USERADDRESS ", fieldUserAddress.getFieldCode());
 Assert.assertEquals("123 Main Street", fieldUserAddress.getResult());

 // We can set this property to get our field to override the value currently stored in the UserInformation object.
 fieldUserAddress.setUserAddress("456 North Road");
 fieldUserAddress.update();

 Assert.assertEquals(" USERADDRESS  \"456 North Road\"", fieldUserAddress.getFieldCode());
 Assert.assertEquals("456 North Road", fieldUserAddress.getResult());

 // This does not affect the value in the UserInformation object.
 Assert.assertEquals("123 Main Street", doc.getFieldOptions().getCurrentUser().getAddress());

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

Parameters:

value - The current user's postal address.

Throws:

java.lang.Exception