Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeBarcodeOptions

OfficeIMO.Drawing.CodeGlyphX

Namespace
OfficeIMO.Drawing.CodeGlyphX
Assembly
OfficeIMO.Drawing.CodeGlyphX
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

Size, appearance and accessibility of a QR code or barcode placed by the OfficeIMO CodeGlyphX adapters. Every property is optional; the defaults produce a scannable symbol at a sensible document size.

Inheritance

  • object
  • OfficeBarcodeOptions

Constructors

public OfficeBarcodeOptions() #

Properties

public OfficeLength? Width { get; set; } #

Width of the whole symbol, including its quiet zone. Two-dimensional codes default to 1.25 inches; linear, stacked and postal codes default to 0.33 mm per module. With only a width, the symbol keeps its proportions.

public OfficeLength? Height { get; set; } #

Height of the whole symbol, including any human-readable text. Linear barcodes adjust their bar height to it; other symbols keep their proportions and fit inside OfficeBarcodeOptions.Width and OfficeBarcodeOptions.Height.

public int? QuietZone { get; set; } #

Light margin around the symbol in modules. Defaults to 4 for two-dimensional codes and 10 for linear barcodes.

public OfficeColor Color { get; set; } #

Color of the bars or dark modules. Use a literal, opaque color.

public OfficeColor BackgroundColor { get; set; } #

Color of the background and quiet zone. Use a literal, opaque color.

public QrErrorCorrectionLevel? ErrorCorrection { get; set; } #

QR error correction level. Applies to QR codes only; CodeGlyphX chooses the level when this is not set.

public bool? HumanReadableText { get; set; } #

Whether a linear barcode prints its human-readable text under the bars. Linear barcodes show it by default; other symbologies do not support it.

public string? AlternativeText { get; set; } #

Accessible description of the symbol. Defaults to the symbology and its payload, for example QR Code: https://evotec.xyz, so screen readers can announce what the code contains.