FieldDisplayBarcode (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Field
- - com.aspose.words.FieldDisplayBarcode

```
public class FieldDisplayBarcode
extends Field
```
Implements the DISPLAYBARCODE field. Inserts a barcode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`getAddStartStopChar()` Gets whether to add Start/Stop characters for barcode types NW7 and CODE39.
`java.lang.String`	`getBackgroundColor()` Gets the background color of the barcode symbol.
`java.lang.String`	`getBarcodeType()` Gets the barcode type (QR, etc.)
`java.lang.String`	`getBarcodeValue()` Gets the barcode value.
`java.lang.String`	`getCaseCodeStyle()` Gets the style of a Case Code for barcode type ITF14.
`boolean`	`getDisplayText()` Gets whether to display barcode data (text) along with image.
`java.lang.String`	`getErrorCorrectionLevel()` Gets an error correction level of QR Code.
`boolean`	`getFixCheckDigit()` Gets whether to fix the check digit if it’s invalid.
`java.lang.String`	`getForegroundColor()` Gets the foreground color of the barcode symbol.
`java.lang.String`	`getPosCodeStyle()` Gets the style of a Point of Sale barcode (barcode types UPCA\|UPCE\|EAN13\|EAN8).
`java.lang.String`	`getScalingFactor()` Gets a scaling factor for the symbol.
`int`	`getSwitchType(java.lang.String switchName)`
`java.lang.String`	`getSymbolHeight()` Gets the height of the symbol.
`java.lang.String`	`getSymbolRotation()` Gets the rotation of the barcode symbol.
`void`	`setAddStartStopChar(boolean value)` Sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
`void`	`setBackgroundColor(java.lang.String value)` Sets the background color of the barcode symbol.
`void`	`setBarcodeType(java.lang.String value)` Sets the barcode type (QR, etc.)
`void`	`setBarcodeValue(java.lang.String value)` Sets the barcode value.
`void`	`setCaseCodeStyle(java.lang.String value)` Sets the style of a Case Code for barcode type ITF14.
`void`	`setDisplayText(boolean value)` Sets whether to display barcode data (text) along with image.
`void`	`setErrorCorrectionLevel(java.lang.String value)` Sets an error correction level of QR Code.
`void`	`setFixCheckDigit(boolean value)` Sets whether to fix the check digit if it’s invalid.
`void`	`setForegroundColor(java.lang.String value)` Sets the foreground color of the barcode symbol.
`void`	`setPosCodeStyle(java.lang.String value)` Sets the style of a Point of Sale barcode (barcode types UPCA\|UPCE\|EAN13\|EAN8).
`void`	`setScalingFactor(java.lang.String value)` Sets a scaling factor for the symbol.
`void`	`setSymbolHeight(java.lang.String value)` Sets the height of the symbol.
`void`	`setSymbolRotation(java.lang.String value)` Sets the rotation of the barcode symbol.

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
  - getBarcodeValue
```
public java.lang.String getBarcodeValue()
```
    Gets the barcode value.
    
    Returns:
    
    The barcode value.
  - setBarcodeValue
```
public void setBarcodeValue(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the barcode value.
    
    Parameters:
    
    value - The barcode value.
    
    Throws:
    
    java.lang.Exception
  - getBarcodeType
```
public java.lang.String getBarcodeType()
```
    Gets the barcode type (QR, etc.)
    
    Returns:
    
    The barcode type (QR, etc.)
  - setBarcodeType
```
public void setBarcodeType(java.lang.String value)
                    throws java.lang.Exception
```
    Sets the barcode type (QR, etc.)
    
    Parameters:
    
    value - The barcode type (QR, etc.)
    
    Throws:
    
    java.lang.Exception
  - getSymbolHeight
```
public java.lang.String getSymbolHeight()
```
    Gets the height of the symbol. The units are in TWIPS (1/1440 inch).
    
    Returns:
    
    The height of the symbol.
  - setSymbolHeight
```
public void setSymbolHeight(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the height of the symbol. The units are in TWIPS (1/1440 inch).
    
    Parameters:
    
    value - The height of the symbol.
    
    Throws:
    
    java.lang.Exception
  - getSymbolRotation
```
public java.lang.String getSymbolRotation()
```
    Gets the rotation of the barcode symbol. Valid values are [0, 3]
    
    Returns:
    
    The rotation of the barcode symbol.
  - setSymbolRotation
```
public void setSymbolRotation(java.lang.String value)
                       throws java.lang.Exception
```
    Sets the rotation of the barcode symbol. Valid values are [0, 3]
    
    Parameters:
    
    value - The rotation of the barcode symbol.
    
    Throws:
    
    java.lang.Exception
  - getScalingFactor
```
public java.lang.String getScalingFactor()
```
    Gets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]
    
    Returns:
    
    A scaling factor for the symbol.
  - setScalingFactor
```
public void setScalingFactor(java.lang.String value)
                      throws java.lang.Exception
```
    Sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]
    
    Parameters:
    
    value - A scaling factor for the symbol.
    
    Throws:
    
    java.lang.Exception
  - getForegroundColor
```
public java.lang.String getForegroundColor()
```
    Gets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
    
    Returns:
    
    The foreground color of the barcode symbol.
  - setForegroundColor
```
public void setForegroundColor(java.lang.String value)
                        throws java.lang.Exception
```
    Sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
    
    Parameters:
    
    value - The foreground color of the barcode symbol.
    
    Throws:
    
    java.lang.Exception
  - getBackgroundColor
```
public java.lang.String getBackgroundColor()
```
    Gets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
    
    Returns:
    
    The background color of the barcode symbol.
  - setBackgroundColor
```
public void setBackgroundColor(java.lang.String value)
                        throws java.lang.Exception
```
    Sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
    
    Parameters:
    
    value - The background color of the barcode symbol.
    
    Throws:
    
    java.lang.Exception
  - getPosCodeStyle
```
public java.lang.String getPosCodeStyle()
```
    Gets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
    
    Returns:
    
    The style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8).
  - setPosCodeStyle
```
public void setPosCodeStyle(java.lang.String value)
                     throws java.lang.Exception
```
    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].
    
    Parameters:
    
    value - The style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8).
    
    Throws:
    
    java.lang.Exception
  - getCaseCodeStyle
```
public java.lang.String getCaseCodeStyle()
```
    Gets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
    
    Returns:
    
    The style of a Case Code for barcode type ITF14.
  - setCaseCodeStyle
```
public void setCaseCodeStyle(java.lang.String value)
                      throws java.lang.Exception
```
    Sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
    
    Parameters:
    
    value - The style of a Case Code for barcode type ITF14.
    
    Throws:
    
    java.lang.Exception
  - getErrorCorrectionLevel
```
public java.lang.String getErrorCorrectionLevel()
```
    Gets an error correction level of QR Code. Valid values are [0, 3].
    
    Returns:
    
    An error correction level of QR Code.
  - setErrorCorrectionLevel
```
public void setErrorCorrectionLevel(java.lang.String value)
                             throws java.lang.Exception
```
    Sets an error correction level of QR Code. Valid values are [0, 3].
    
    Parameters:
    
    value - An error correction level of QR Code.
    
    Throws:
    
    java.lang.Exception
  - getDisplayText
```
public boolean getDisplayText()
```
    Gets whether to display barcode data (text) along with image.
    
    Returns:
    
    Whether to display barcode data (text) along with image.
  - setDisplayText
```
public void setDisplayText(boolean value)
                    throws java.lang.Exception
```
    Sets whether to display barcode data (text) along with image.
    
    Parameters:
    
    value - Whether to display barcode data (text) along with image.
    
    Throws:
    
    java.lang.Exception
  - getAddStartStopChar
```
public boolean getAddStartStopChar()
```
    Gets whether to add Start/Stop characters for barcode types NW7 and CODE39.
    
    Returns:
    
    Whether to add Start/Stop characters for barcode types NW7 and CODE39.
  - setAddStartStopChar
```
public void setAddStartStopChar(boolean value)
                         throws java.lang.Exception
```
    Sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
    
    Parameters:
    
    value - Whether to add Start/Stop characters for barcode types NW7 and CODE39.
    
    Throws:
    
    java.lang.Exception
  - getFixCheckDigit
```
public boolean getFixCheckDigit()
```
    Gets whether to fix the check digit if it’s invalid.
    
    Returns:
    
    Whether to fix the check digit if it’s invalid.
  - setFixCheckDigit
```
public void setFixCheckDigit(boolean value)
                      throws java.lang.Exception
```
    Sets whether to fix the check digit if it’s invalid.
    
    Parameters:
    
    value - Whether to fix the check digit if it’s invalid.
    
    Throws:
    
    java.lang.Exception
  - getSwitchType
```
public int getSwitchType(java.lang.String switchName)
```

Class FieldDisplayBarcode

Method Summary

Methods inherited from class com.aspose.words.Field

Methods inherited from class java.lang.Object

Method Detail

getBarcodeValue

setBarcodeValue

getBarcodeType

setBarcodeType

getSymbolHeight

setSymbolHeight

getSymbolRotation

setSymbolRotation

getScalingFactor

setScalingFactor

getForegroundColor

setForegroundColor

getBackgroundColor

setBackgroundColor

getPosCodeStyle

setPosCodeStyle

getCaseCodeStyle

setCaseCodeStyle

getErrorCorrectionLevel

setErrorCorrectionLevel

getDisplayText

setDisplayText

getAddStartStopChar

setAddStartStopChar

getFixCheckDigit

setFixCheckDigit

getSwitchType