com.aspose.words

Class FieldBarcode

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldBarcode

public class FieldBarcode
extends Field

Implements the BARCODE field. Inserts a postal barcode in a machine-readable form of address used by the U.S. Postal Service.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFacingIdentificationMark() Gets the type of a Facing Identification Mark (FIM) to insert.
java.lang.String	getPostalAddress() Gets the postal address used for generating a barcode or the name of the bookmark that refers to it.
int	getSwitchType(java.lang.String switchName)
boolean	isBookmark() Gets whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.
void	isBookmark(boolean value) Sets whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.
boolean	isUSPostalAddress() Gets whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S.
void	isUSPostalAddress(boolean value) Sets whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S.
void	setFacingIdentificationMark(java.lang.String value) Sets the type of a Facing Identification Mark (FIM) to insert.
void	setPostalAddress(java.lang.String value) Sets the postal address used for generating a barcode or the name of the bookmark that refers to it.

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

getPostalAddress

public java.lang.String getPostalAddress()

Gets the postal address used for generating a barcode or the name of the bookmark that refers to it.

Returns:

The postal address used for generating a barcode or the name of the bookmark that refers to it.

setPostalAddress

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

Sets the postal address used for generating a barcode or the name of the bookmark that refers to it.

Parameters:

value - The postal address used for generating a barcode or the name of the bookmark that refers to it.

Throws:

java.lang.Exception

isBookmark

public boolean isBookmark()

Gets whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.

Returns:

Whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.

isBookmark

public void isBookmark(boolean value)
                throws java.lang.Exception

Sets whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.

Parameters:

value - Whether getPostalAddress() / setPostalAddress(java.lang.String) is the name of a bookmark.

Throws:

java.lang.Exception

getFacingIdentificationMark

public java.lang.String getFacingIdentificationMark()

Gets the type of a Facing Identification Mark (FIM) to insert.

Returns:

The type of a Facing Identification Mark (FIM) to insert.

setFacingIdentificationMark

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

Sets the type of a Facing Identification Mark (FIM) to insert.

Parameters:

value - The type of a Facing Identification Mark (FIM) to insert.

Throws:

java.lang.Exception

isUSPostalAddress

public boolean isUSPostalAddress()

Gets whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S. postal address.

Returns:

Whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S.

isUSPostalAddress

public void isUSPostalAddress(boolean value)
                       throws java.lang.Exception

Sets whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S. postal address.

Parameters:

value - Whether getPostalAddress() / setPostalAddress(java.lang.String) is a U.S.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)