com.aspose.words
Class FieldAddressBlock

java.lang.Object
  extended by Field
      extended by com.aspose.words.FieldAddressBlock

public class FieldAddressBlock 
extends Field

Implements the ADDRESSBLOCK field. Represents an address block. An address block is a block of text specifying information appropriate for a postal mailing address, in the order required by the destination country.

Constructor Summary
FieldAddressBlock()
          
 
Property Getters/Setters Summary
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetExcludedCountryOrRegionName()
voidsetExcludedCountryOrRegionName(java.lang.String value)
           Gets or sets the excluded country/region name.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleangetFormatAddressOnCountryOrRegion()
voidsetFormatAddressOnCountryOrRegion(boolean value)
           Gets or sets whether to format the address according to the country/region of the recipient as defined by POST*CODE (Universal Postal Union 2006).
java.lang.StringgetIncludeCountryOrRegionName()
voidsetIncludeCountryOrRegionName(java.lang.String value)
           Gets or sets whether to include the name of the country/region.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetLanguageId()
voidsetLanguageId(java.lang.String value)
           Gets or sets the language ID used to format the address.
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
java.lang.StringgetNameAndAddressFormat()
voidsetNameAndAddressFormat(java.lang.String value)
           Gets or sets the name and address format.
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
java.lang.String[]getFieldNames()
           Returns a collection of mail merge field names used by the field.
java.lang.StringgetMergeFormat()
          Reserved for internal use.
aspose.obfuscated.typegetPlaceholdersToFieldsMap()
          Reserved for internal use.
java.lang.StringgetPlaceholderValue(aspose.obfuscated.type context, aspose.obfuscated.type placeholder)
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
Aspose.Words.DocumentiFormattableMergeField_FetchDocument()
          Reserved for internal use.
Aspose.Words.Noderemove()→ inherited from Field
           Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
 

Constructor Detail

FieldAddressBlock

public FieldAddressBlock()

Property Getters/Setters Detail

getEnd

→ inherited from Field
public FieldEnd getEnd()
Gets the node that represents the field end.

getExcludedCountryOrRegionName/setExcludedCountryOrRegionName

public java.lang.String getExcludedCountryOrRegionName() / public void setExcludedCountryOrRegionName(java.lang.String value)
Gets or sets the excluded country/region name.

getFormat

→ inherited from Field
public FieldFormat getFormat()
Gets a FieldFormat object that provides typed access to field's formatting.

getFormatAddressOnCountryOrRegion/setFormatAddressOnCountryOrRegion

public boolean getFormatAddressOnCountryOrRegion() / public void setFormatAddressOnCountryOrRegion(boolean value)
Gets or sets whether to format the address according to the country/region of the recipient as defined by POST*CODE (Universal Postal Union 2006).

getIncludeCountryOrRegionName/setIncludeCountryOrRegionName

public java.lang.String getIncludeCountryOrRegionName() / public void setIncludeCountryOrRegionName(java.lang.String value)
Gets or sets whether to include the name of the country/region.

isDirty/isDirty

→ inherited from Field
public boolean isDirty() / public void isDirty(boolean value)
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

isLocked/isLocked

→ inherited from Field
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the field is locked (should not recalculate its result).

getLanguageId/setLanguageId

public java.lang.String getLanguageId() / public void setLanguageId(java.lang.String value)
Gets or sets the language ID used to format the address.

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)
Gets or sets the LCID of the field.
See Also:
FieldUpdateCultureSource.FIELD_CODE

getNameAndAddressFormat/setNameAndAddressFormat

public java.lang.String getNameAndAddressFormat() / public void setNameAndAddressFormat(java.lang.String value)
Gets or sets the name and address format.

getResult/setResult

→ inherited from Field
public java.lang.String getResult() / public void setResult(java.lang.String value)
Gets or sets text that is between the field separator and field end.

getSeparator

→ inherited from Field
public FieldSeparator getSeparator()
Gets the node that represents the field separator. Can be null.

getStart

→ inherited from Field
public FieldStart getStart()
Gets the node that represents the start of the field.

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

getFieldNames

public java.lang.String[] getFieldNames()
                      throws java.lang.Exception
Returns a collection of mail merge field names used by the field.

getMergeFormat

public java.lang.String getMergeFormat()
Reserved for internal use.

getPlaceholdersToFieldsMap

public aspose.obfuscated.type getPlaceholdersToFieldsMap()
Reserved for internal use.

getPlaceholderValue

public java.lang.String getPlaceholderValue(aspose.obfuscated.type context, aspose.obfuscated.type placeholder)
                          throws java.lang.Exception
Reserved for internal use.

getSwitchType

public aspose.obfuscated.type getSwitchType(java.lang.String switchName)
Reserved for internal use.

iFormattableMergeField_FetchDocument

public Aspose.Words.Document iFormattableMergeField_FetchDocument()
Reserved for internal use.

remove

→ inherited from Field
public Aspose.Words.Node remove()
           throws java.lang.Exception
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Returns:
True if the field has been unlinked, otherwise false.

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.