Show / Hide Table of Contents

# Class BarcodeOptions

##### Inheritance

object
OptionsBase
BarcodeOptions

##### Inherited Members

OptionsBase.mObjSet
OptionsBase.ColorPtToNumber(ColorPt)
OptionsBase.ColorPtFromNumber(double)
OptionsBase.GetArray(string)
OptionsBase.PutNumber(string, double)
OptionsBase.PutBool(string, bool)
OptionsBase.PutText(string, string)
OptionsBase.PutRect(string, Rect)
OptionsBase.PushBackNumber(string, double)
OptionsBase.PushBackBool(string, bool)
OptionsBase.PushBackText(string, string)
OptionsBase.PushBackRect(string, Rect)
OptionsBase.RectFromArray(Obj)
OptionsBase.insertRectCollection(string, RectCollection, int)
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

###### Namespace: pdftron.PDF

###### Assembly: PDFNet.dll

##### Syntax

    public class BarcodeOptions : OptionsBase

### Constructors

#### BarcodeOptions()

Constructor.

##### Declaration

    public BarcodeOptions()

### Methods

#### GetBarcodeOrientations()

Gets the value BarcodeOrientations from the options object. Specifies a set of barcode orientations to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeOrientation to select the orientations of interest. By default, all orientations are searched for. Additional search directions can have a modest impact on search time. Orientation only affects the following barcode types: e_linear, e_post_net_planet, e_four_state, e_gs1_databar_stacked, e_pdf417, e_micro_pdf417, e_patch_code and e_pharma_code.

##### Declaration

    public BarcodeOptions.BarcodeOrientation GetBarcodeOrientations()

##### Returns

Type | Description
--- | ---
BarcodeOptions.BarcodeOrientation | Specifies a set of barcode orientations to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeOrientation to select the orientations of interest. By default, all orientations are searched for. Additional search directions can have a modest impact on search time. Orientation only affects the following barcode types: e_linear, e_post_net_planet, e_four_state, e_gs1_databar_stacked, e_pdf417, e_micro_pdf417, e_patch_code and e_pharma_code.

#### GetBarcodeProfile()

Gets the value BarcodeProfile from the options object. Specifies the barcode detection profile. Depending on the type and quality of the input, specialized profiles may return a better result at the cost of a slight runtime performance penalty. Barcode detection has the best runtime performance on high quality sources with the default profile.

##### Declaration

    public BarcodeOptions.BarcodeProfile GetBarcodeProfile()

##### Returns

Type | Description
--- | ---
BarcodeOptions.BarcodeProfile | Specifies the barcode detection profile. Depending on the type and quality of the input, specialized profiles may return a better result at the cost of a slight runtime performance penalty. Barcode detection has the best runtime performance on high quality sources with the default profile.

#### GetBarcodeSearchTypes()

Gets the value BarcodeSearchTypes from the options object. Specifies a set of barcode types to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeTypeGroup to select the types of interest. Searching for barcodes takes approximately linear time in the number of barcode types to be searched for. By specifying only the types of barcodes of interest, runtime may be significantly improved. By default, all types are searched for.

##### Declaration

    public BarcodeOptions.BarcodeTypeGroup GetBarcodeSearchTypes()

##### Returns

Type | Description
--- | ---
BarcodeOptions.BarcodeTypeGroup | Specifies a set of barcode types to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeTypeGroup to select the types of interest. Searching for barcodes takes approximately linear time in the number of barcode types to be searched for. By specifying only the types of barcodes of interest, runtime may be significantly improved. By default, all types are searched for.

#### GetDataOutputFormat()

Gets the value DataOutputFormat from the options object. Specifies the format of the data output. The default is "auto", which will attempt to decode the barcode data to a string if possible. Otherwise, a Base64-encoded binary stream will be used. If the data is known to be binary, the output format can be set to "binary" to avoid unnecessary decoding attempts. Data returned as binary will be stored in the "data" field of the barcode object in the output JSON, while decoded data will be stored in the "text" field.

##### Declaration

    public BarcodeOptions.OutputFormat GetDataOutputFormat()

##### Returns

Type | Description
--- | ---
BarcodeOptions.OutputFormat | Specifies the format of the data output. The default is "auto", which will attempt to decode the barcode data to a string if possible. Otherwise, a Base64-encoded binary stream will be used. If the data is known to be binary, the output format can be set to "binary" to avoid unnecessary decoding attempts. Data returned as binary will be stored in the "data" field of the barcode object in the output JSON, while decoded data will be stored in the "text" field.

#### GetPages()

Gets the value Pages from the options object. Specifies a range of pages on which to perform barcode extraction, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

##### Declaration

    public string GetPages()

##### Returns

Type | Description
--- | ---
string | Specifies a range of pages on which to perform barcode extraction, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

#### SetBarcodeOrientations(BarcodeOrientation)

Sets the value for BarcodeOrientations in the options object. Specifies a set of barcode orientations to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeOrientation to select the orientations of interest. By default, all orientations are searched for. Additional search directions can have a modest impact on search time. Orientation only affects the following barcode types: e_linear, e_post_net_planet, e_four_state, e_gs1_databar_stacked, e_pdf417, e_micro_pdf417, e_patch_code and e_pharma_code.

##### Declaration

    public BarcodeOptions SetBarcodeOrientations(BarcodeOptions.BarcodeOrientation value)

##### Parameters

Type | Name | Description
--- | --- | ---
BarcodeOptions.BarcodeOrientation | value | Specifies a set of barcode orientations to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeOrientation to select the orientations of interest. By default, all orientations are searched for. Additional search directions can have a modest impact on search time. Orientation only affects the following barcode types: e_linear, e_post_net_planet, e_four_state, e_gs1_databar_stacked, e_pdf417, e_micro_pdf417, e_patch_code and e_pharma_code.

##### Returns

Type | Description
--- | ---
BarcodeOptions | This object, for call chaining.

#### SetBarcodeProfile(BarcodeProfile)

Sets the value for BarcodeProfile in the options object. Specifies the barcode detection profile. Depending on the type and quality of the input, specialized profiles may return a better result at the cost of a slight runtime performance penalty. Barcode detection has the best runtime performance on high quality sources with the default profile.

##### Declaration

    public BarcodeOptions SetBarcodeProfile(BarcodeOptions.BarcodeProfile value)

##### Parameters

Type | Name | Description
--- | --- | ---
BarcodeOptions.BarcodeProfile | value | Specifies the barcode detection profile. Depending on the type and quality of the input, specialized profiles may return a better result at the cost of a slight runtime performance penalty. Barcode detection has the best runtime performance on high quality sources with the default profile.

##### Returns

Type | Description
--- | ---
BarcodeOptions | This object, for call chaining.

#### SetBarcodeSearchTypes(BarcodeTypeGroup)

Sets the value for BarcodeSearchTypes in the options object. Specifies a set of barcode types to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeTypeGroup to select the types of interest. Searching for barcodes takes approximately linear time in the number of barcode types to be searched for. By specifying only the types of barcodes of interest, runtime may be significantly improved. By default, all types are searched for.

##### Declaration

    public BarcodeOptions SetBarcodeSearchTypes(BarcodeOptions.BarcodeTypeGroup value)

##### Parameters

Type | Name | Description
--- | --- | ---
BarcodeOptions.BarcodeTypeGroup | value | Specifies a set of barcode types to be searched for in the target PDF. This value can be created by bitwise OR-ing together various values from BarcodeTypeGroup to select the types of interest. Searching for barcodes takes approximately linear time in the number of barcode types to be searched for. By specifying only the types of barcodes of interest, runtime may be significantly improved. By default, all types are searched for.

##### Returns

Type | Description
--- | ---
BarcodeOptions | This object, for call chaining.

#### SetDataOutputFormat(OutputFormat)

Sets the value for DataOutputFormat in the options object. Specifies the format of the data output. The default is "auto", which will attempt to decode the barcode data to a string if possible. Otherwise, a Base64-encoded binary stream will be used. If the data is known to be binary, the output format can be set to "binary" to avoid unnecessary decoding attempts. Data returned as binary will be stored in the "data" field of the barcode object in the output JSON, while decoded data will be stored in the "text" field.

##### Declaration

    public BarcodeOptions SetDataOutputFormat(BarcodeOptions.OutputFormat value)

##### Parameters

Type | Name | Description
--- | --- | ---
BarcodeOptions.OutputFormat | value | Specifies the format of the data output. The default is "auto", which will attempt to decode the barcode data to a string if possible. Otherwise, a Base64-encoded binary stream will be used. If the data is known to be binary, the output format can be set to "binary" to avoid unnecessary decoding attempts. Data returned as binary will be stored in the "data" field of the barcode object in the output JSON, while decoded data will be stored in the "text" field.

##### Returns

Type | Description
--- | ---
BarcodeOptions | This object, for call chaining.

#### SetPages(string)

Sets the value for Pages in the options object. Specifies a range of pages on which to perform barcode extraction, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

##### Declaration

    public BarcodeOptions SetPages(string value)

##### Parameters

Type | Name | Description
--- | --- | ---
string | value | Specifies a range of pages on which to perform barcode extraction, such as "1-5", or "1-3,5,7-10". Open ended ranges are supported, e.g., "3-". By default all pages are converted. The first page is page number 1.

##### Returns

Type | Description
--- | ---
BarcodeOptions | This object, for call chaining.