java.lang.Object
Field
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.
Method Summary |
java.lang.String | getFieldCode() | → 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.String | getFieldCode(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.String | getMergeFormat() | |
Reserved for internal use. |
aspose.obfuscated.type | getPlaceholdersToFieldsMap() | |
Reserved for internal use. |
java.lang.String | getPlaceholderValue(aspose.obfuscated.type context, aspose.obfuscated.type placeholder) | |
Reserved for internal use. |
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. |
Aspose.Words.Document | iFormattableMergeField_FetchDocument() | |
Reserved for internal use. |
Aspose.Words.Node | remove() | → 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.
|
boolean | unlink() | → inherited from Field |
Performs the field unlink.
|
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already.
|
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already.
|
FieldAddressBlock
public FieldAddressBlock()
-
Property Getters/Setters Detail |
-
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.
-
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.
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.
-
Gets the node that represents the field separator. Can be null.
-
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.
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.