X12Validator Control

Properties   Methods   Events   Config Settings   Errors  

The X12Validator control validates X12 documents against the specified standard, ensuring compliance and correctness.

Syntax

X12Validator

Remarks

This component provides a simple way to validate an EDI document and obtain details about any validation errors.

Before calling Validate call LoadSchema to load the schema for the document to be validated. The schema defines many validation rules such as minimum and maximum lengths, minimum and maximum occurrences, and more. The validation performed by the control depends largely on the schema's definition.

When the Validate method is called the control will attempt to validate the document. If errors are found during validation the ValidationErrors property will be populated with details of each error.

Inspect the ValidationErrors property for information on any errors that were encountered.

Validation Example validator.InputFile = @"C:\X12_Files\810_InvalidRepeat.txt"; validator.LoadSchema(@"C:\X12_Schemas\4010.xml", "810"); validator.Validate(); foreach (X12ValidationErrorDetail error in validator.ValidationErrors) { Console.WriteLine(error.ErrorCode + ": " + error.ErrorMessage); }

Property List

---

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

DelimiterComponent Property (X12Validator Control)

The delimiter separating controls.

Syntax

x12validatorcontrol.DelimiterComponent[=string]

Default Value

":"

Remarks

The delimiter separating components.

In X12Reader, this type is used to hold the delimiters found when parsing the component, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterElement Property (X12Validator Control)

The delimiter separating elements.

Syntax

x12validatorcontrol.DelimiterElement[=string]

Default Value

"*"

Remarks

The delimiter separating elements.

In X12Reader, this type is used to hold the delimiters found when parsing the element, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterRepetition Property (X12Validator Control)

The delimiter separating controls.

Syntax

x12validatorcontrol.DelimiterRepetition[=string]

Default Value

"^"

Remarks

The delimiter separating components.

In X12Reader, this type is used to hold the delimiters found when parsing the component, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

DelimiterSegment Property (X12Validator Control)

The delimiter separating segments.

Syntax

x12validatorcontrol.DelimiterSegment[=string]

Default Value

"~"

Remarks

The delimiter separating segments.

In X12Reader, this type is used to hold the delimiters found when parsing the segment, while in X12Writer the fields can be set to choose the delimiters that will be used when writing

This property is not available at design time.

Data Type

String

InputData Property (X12Validator Control)

The EDI message, specified as a string.

Syntax

x12validatorcontrol.InputData[=string]

Default Value

""

Remarks

Set this property to specify the input EDI message as a string. The message can then be parsed with Parse.

This property is not available at design time.

Data Type

String

InputFile Property (X12Validator Control)

The file containing the EDI message.

Syntax

x12validatorcontrol.InputFile[=string]

Default Value

""

Remarks

Set this property to specify the input EDI message as a file. The message can then be parsed with Parse.

If the file is not found or cannot be opened, an error will be returned.

Note: If both InputFile and InputData are set, InputData takes precedence.

This property is not available at design time.

Data Type

String

ValidationErrorCount Property (X12Validator Control)

The number of records in the ValidationError arrays.

Syntax

x12validatorcontrol.ValidationErrorCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ValidationErrorColumn
• ValidationErrorComponentIndex
• ValidationErrorElementIndex
• ValidationErrorErrorCode
• ValidationErrorErrorMessage
• ValidationErrorErrorType
• ValidationErrorFGroupIndex
• ValidationErrorInterchangeIndex
• ValidationErrorLine
• ValidationErrorPosition
• ValidationErrorSegmentIndex
• ValidationErrorSegmentTag
• ValidationErrorTransactionSetIndex

The array indices start at 0 and end at ValidationErrorCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorColumn Property (X12Validator Control)

The column number where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorColumn(ValidationErrorIndex)

Default Value

0

Remarks

The column number where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorComponentIndex Property (X12Validator Control)

This property holds the position of the control element where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorComponentIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property holds the position of the component element where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorElementIndex Property (X12Validator Control)

This property holds the position of the element where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorElementIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property holds the position of the element where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorErrorCode Property (X12Validator Control)

The ErrorCode property contains the type of error encountered.

Syntax

x12validatorcontrol.ValidationErrorErrorCode(ValidationErrorIndex)

Default Value

"0"

Remarks

The ValidationErrorErrorCode property contains the type of error encountered.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorErrorMessage Property (X12Validator Control)

ErrorMessage is a textual description of the error.

Syntax

x12validatorcontrol.ValidationErrorErrorMessage(ValidationErrorIndex)

Default Value

""

Remarks

ValidationErrorErrorMessage is a textual description of the error.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorErrorType Property (X12Validator Control)

Indicates the level of the document where the error was encountered.

Syntax

x12validatorcontrol.ValidationErrorErrorType(ValidationErrorIndex)

Default Value

0

Remarks

Indicates the level of the document where the error was encountered. Possible values include:

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorFGroupIndex Property (X12Validator Control)

This property holds the position of the functional group where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorFGroupIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property holds the position of the functional group where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorInterchangeIndex Property (X12Validator Control)

This property holds the position of the interchange where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorInterchangeIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property holds the position of the interchange where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorLine Property (X12Validator Control)

The line number where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorLine(ValidationErrorIndex)

Default Value

0

Remarks

The line number where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorPosition Property (X12Validator Control)

This property holds the byte position in the EDI stream where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorPosition(ValidationErrorIndex)

Default Value

0

Remarks

This property holds the byte position in the EDI stream where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Long64

ValidationErrorSegmentIndex Property (X12Validator Control)

This property is the index of the segment where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorSegmentIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property is the index of the segment where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

ValidationErrorSegmentTag Property (X12Validator Control)

This property specifies the tag name of the segment where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorSegmentTag(ValidationErrorIndex)

Default Value

""

Remarks

This property specifies the tag name of the segment where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

String

ValidationErrorTransactionSetIndex Property (X12Validator Control)

This property holds the position of the message where the error occurred.

Syntax

x12validatorcontrol.ValidationErrorTransactionSetIndex(ValidationErrorIndex)

Default Value

1

Remarks

This property holds the position of the message where the error occurred.

The ValidationErrorIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ValidationErrorCount property.

This property is read-only and not available at design time.

Data Type

Integer

Config Method (X12Validator Control)

Sets or retrieves a configuration setting.

Syntax

x12validatorcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

LoadSchema Method (X12Validator Control)

Loads schema information from a file or string data.

Syntax

x12validatorcontrol.LoadSchema fileOrData, messagename

Remarks

This method loads schema information for use when parsing, validating, and translating messages.

The FileOrData parameter can be set to the path of a file containing schema data, or can be set to the contents of a schema file directly.

MessageName can be set to the name of a specific message to load only the specified message's schema information. If left empty or set to "*", the entire schema will be loaded.

Reset Method (X12Validator Control)

Resets all properties to their default values.

Syntax

x12validatorcontrol.Reset 

Remarks

This method resets all properties of the component to their default values as specified in the property definitions.

Validate Method (X12Validator Control)

Validate the EDI document and warn about any errors encountered.

Syntax

x12validatorcontrol.Validate 

Remarks

This method parses the input EDI document, firing the ValidateWarning event for any non-blocking errors it encounters.

Error Event (X12Validator Control)

Fires when a parsing error occurs.

Syntax

Sub x12validatorcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

This event fires when the control encounters a parsing error while processing a document.

ResolveSchema Event (X12Validator Control)

Fires to request schema information for a specific transaction set.

Syntax

Sub x12validatorcontrol_ResolveSchema(VersionNumber As String, TransactionSetIDCode As String)

Remarks

LoadSchema can be called from within this event to load the schema information for the specified transaction set.

ValidateWarning Event (X12Validator Control)

Fires to warn about validation errors.

Syntax

Sub x12validatorcontrol_ValidateWarning(Position As Long64, Line As Integer, Column As Integer, ErrorCode As String, ErrorMessage As String, ErrorType As Integer)

Remarks

When the control encounters a non-blocking error while validating a document, this event fires with information about the error.

Config Settings (X12Validator Control)

The control accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

X12Validator Config Settings

Trappable Errors (X12Validator Control)

X12Validator Errors