java.lang.ObjectField
com.aspose.words.FieldDisplayBarcode
public class FieldDisplayBarcode
Constructor Summary |
---|
FieldDisplayBarcode()
|
Property Getters/Setters Summary | ||
---|---|---|
boolean | getAddStartStopChar() | |
void | setAddStartStopChar(boolean value) | |
Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39. | ||
java.lang.String | getBackgroundColor() | |
void | setBackgroundColor(java.lang.String value) | |
Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF] | ||
java.lang.String | getBarcodeType() | |
void | setBarcodeType(java.lang.String value) | |
Gets or sets the barcode type (QR, etc.) | ||
java.lang.String | getBarcodeValue() | |
void | setBarcodeValue(java.lang.String value) | |
Gets or sets the barcode value. | ||
java.lang.String | getCaseCodeStyle() | |
void | setCaseCodeStyle(java.lang.String value) | |
Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD] | ||
boolean | getDisplayText() | |
void | setDisplayText(boolean value) | |
Gets or sets whether to display barcode data (text) along with image. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getErrorCorrectionLevel() | |
void | setErrorCorrectionLevel(java.lang.String value) | |
Gets or sets an error correction level of QR Code. Valid values are [0, 3]. | ||
boolean | getFixCheckDigit() | |
void | setFixCheckDigit(boolean value) | |
Gets or sets whether to fix the check digit if it’s invalid. | ||
java.lang.String | getForegroundColor() | |
void | setForegroundColor(java.lang.String value) | |
Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF] | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getPosCodeStyle() | |
void | setPosCodeStyle(java.lang.String value) | |
Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE]. | ||
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
Gets or sets text that is between the field separator and field end. | ||
java.lang.String | getScalingFactor() | |
void | setScalingFactor(java.lang.String value) | |
Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000] | ||
FieldSeparator | getSeparator() | → inherited from Field |
Gets the node that represents the field separator. Can be null. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getSymbolHeight() | |
void | setSymbolHeight(java.lang.String value) | |
Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch). | ||
java.lang.String | getSymbolRotation() | |
void | setSymbolRotation(java.lang.String value) | |
Gets or sets the rotation of the barcode symbol. Valid values are [0, 3] | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. |
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). | ||
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. |
Constructor Detail |
---|
public FieldDisplayBarcode()
Property Getters/Setters Detail |
---|
getAddStartStopChar/setAddStartStopChar | |
public boolean getAddStartStopChar() / public void setAddStartStopChar(boolean value) |
getBackgroundColor/setBackgroundColor | |
public java.lang.String getBackgroundColor() / public void setBackgroundColor(java.lang.String value) |
getBarcodeType/setBarcodeType | |
public java.lang.String getBarcodeType() / public void setBarcodeType(java.lang.String value) |
getBarcodeValue/setBarcodeValue | |
public java.lang.String getBarcodeValue() / public void setBarcodeValue(java.lang.String value) |
getCaseCodeStyle/setCaseCodeStyle | |
public java.lang.String getCaseCodeStyle() / public void setCaseCodeStyle(java.lang.String value) |
getDisplayText/setDisplayText | |
public boolean getDisplayText() / public void setDisplayText(boolean value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getErrorCorrectionLevel/setErrorCorrectionLevel | |
public java.lang.String getErrorCorrectionLevel() / public void setErrorCorrectionLevel(java.lang.String value) |
getFixCheckDigit/setFixCheckDigit | |
public boolean getFixCheckDigit() / public void setFixCheckDigit(boolean value) |
getForegroundColor/setForegroundColor | |
public java.lang.String getForegroundColor() / public void setForegroundColor(java.lang.String value) |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getPosCodeStyle/setPosCodeStyle | |
public java.lang.String getPosCodeStyle() / public void setPosCodeStyle(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
getScalingFactor/setScalingFactor | |
public java.lang.String getScalingFactor() / public void setScalingFactor(java.lang.String value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getStart | → inherited from Field |
public FieldStart getStart() |
getSymbolHeight/setSymbolHeight | |
public java.lang.String getSymbolHeight() / public void setSymbolHeight(java.lang.String value) |
getSymbolRotation/setSymbolRotation | |
public java.lang.String getSymbolRotation() / public void setSymbolRotation(java.lang.String value) |
getType | → inherited from Field |
public int getType() |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
remove | → inherited from Field |
public Node remove() throws java.lang.Exception |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update() throws java.lang.Exception |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.