API Reference

Class

Gs1

Edit on GitHub

Namespace CodeGlyphX

Assembly CodeGlyphX

Source ../../../../_/CodeGlyphX/Gs1.cs:19

Modifiers static

High-level helpers for parsing, validating, building, and encoding GS1 Application Identifier messages.

Inheritance

Object
Gs1

Methods

public static Gs1DigitalLinkUri DigitalLink(IReadOnlyList<Gs1Element> elements, String primaryIdentifierAi = null) #

../../../../_/CodeGlyphX/Gs1.cs:46

Returns: Gs1DigitalLinkUri

Builds a canonical GS1 Digital Link URI on https://id.gs1.org.

Parameters

elements System.Collections.Generic.IReadOnlyList{CodeGlyphX.Gs1Element} requiredposition: 0
primaryIdentifierAi System.String = null optionalposition: 1

ElementString 2 overloads

public static String ElementString(String aiText) #

../../../../_/CodeGlyphX/Gs1.cs:54

Returns: String

Builds a machine-readable element string from bracketed syntax such as (01)09506000134352(10)ABC(17)240101. FNC1 separators are inserted from catalog metadata.

Parameters

aiText System.String requiredposition: 0

public static String ElementString(params Gs1Element[] elements) #

../../../../_/CodeGlyphX/Gs1.cs:68

Returns: String

Builds a GS1 element string from explicit elements.

Parameters

elements CodeGlyphX.Gs1Element[] requiredposition: 0

Encode128 2 overloads

public static Barcode1D Encode128(String aiText) #

../../../../_/CodeGlyphX/Gs1.cs:73

Returns: Barcode1D

Encodes a GS1-128 barcode from bracketed syntax or a raw element string.

Parameters

aiText System.String requiredposition: 0

public static Barcode1D Encode128(params Gs1Element[] elements) #

../../../../_/CodeGlyphX/Gs1.cs:78

Returns: Barcode1D

Encodes a GS1-128 barcode from explicit elements.

Parameters

elements CodeGlyphX.Gs1Element[] requiredposition: 0

public static IReadOnlyList<Gs1Element> Parse(String input, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1.cs:29

Returns: IReadOnlyList<Gs1Element>

Parses a valid GS1 message into its assigned Application Identifier elements.

Parameters

input System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

public static Gs1DigitalLinkUri ParseDigitalLink(String uri, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1.cs:41

Returns: Gs1DigitalLinkUri

Parses a valid uncompressed GS1 Digital Link URI Syntax 1.6.0 value.

Parameters

uri System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

public static Boolean TryValidate(String input, out Gs1ValidationResult result, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1.cs:24

Returns: Boolean

Attempts to parse and fully validate a GS1 message.

Parameters

input System.String requiredposition: 0
result CodeGlyphX.Gs1Data.Gs1ValidationResult@ requiredposition: 1
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 2

public static Gs1ValidationResult Validate(String input, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1.cs:19

Returns: Gs1ValidationResult

Parses and validates bracketed GS1 syntax or a raw element string against the bundled official catalog.

Parameters

input System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

public static Gs1DigitalLinkValidationResult ValidateDigitalLink(String uri, Gs1ValidationOptions options = null) #

../../../../_/CodeGlyphX/Gs1.cs:36

Returns: Gs1DigitalLinkValidationResult

Parses and validates an uncompressed GS1 Digital Link URI Syntax 1.6.0 value.

Parameters

uri System.String requiredposition: 0
options CodeGlyphX.Gs1Data.Gs1ValidationOptions = null optionalposition: 1

Inherited Methods

Fields

public const Char GroupSeparator #

ASCII Group Separator (FNC1) used between variable-length GS1 elements.

Value: