ediDataSegment

The ediDataSegment represents a record of information in the EDI standard.  It is made up of a collection of composite elements and of simple data elements.

Methods

• DescribeSyntax- Sets or gets the description the hierarchical syntax.
• First - Gets the first Data Segment in the next nested (or higher) loop level.
• GetDataElementByPos - Returns the data element object in the document tree hierarchy that was specified by the hierarchical string.
• GetDataSegmentByPos - Returns the data segment object in the document tree hierarchy that was specified by the hierarchical string.
• GetGroup - Returns the functional group that contains the data segment.
• GetHierarchyString - Returns the hierarchy string syntax of the data segment.
• GetInterchange - Returns the interchange that contains the data segment.
• GetInterconnectMailbag - Returns the Interconnect Mailbag context that contains the data segment.
• GetSchema - Returns the schema of the guideline that was used to create an instance of the Data Segment.
• GetSegmentGroup - Returns the segments object containing a collection of data segments that are in the same segment group..
• GetTransactionSet - Returns the transaction set or message that contains the data segment.
• Last - Returns the first Data Segment in the deepest nested (or highest) loop level.
• Next - Returns the next Data Segment (from the current Data Segment) in a document.
• NextInstance - Returns the next data segment that is in the same instance of the calling data segment.
• Previous - Returns the previous Data Segment in the document from the current Data Segment.
• PreviousInstance - Returns the previous data segment that is in the same instance of the calling data segment.
• ReadNext - Returns a data segment object that contains unverified data from the document.
• RecordAckCode - Records an error code pertinent to the data segment in the acknowledgment document.
• Refresh - Refreshes the state information of the data segment.

Properties

• Area - Returns the area or table of the Transaction Set that the current Data Segment is in.
• CompositeTerminator - Returns the composite terminator.
• Count - Returns the number of Data Elements in the Data Segment.
• CurrentLoop - Returns the loop tag of the current loop that the data segment belongs to.
• DataElement - Gets the Data Element member in a Data Segment.
• DataElements - Returns an object that contains all the Data Elements in the Data Segment.
• DataElementFileValue - Gets or set the contents of a file to the value of a Data Element in the Data Segment.
• DataElementImageValue - Gets or sets an image to the value of a Data Element in the Data Segment.
• DataElementValue - Gets or sets the value of a Data Element in the Data Segment.
• DataElementValueByPos - Gets or sets the value of a data element whose location is specified by the hierarchical string.
• DataSegmentType - Returns the Data Segment type of the Data Segment.
• DecimalNotation - Returns the Decimal Notation used in the document.
• Definition - Returns the matching definition object of the Data Segment from the schema.
• Description - Returns the description of the Data Segment.
• ElementTerminator - Returns the Data Element terminator.
• GroupHandle - Returns the handle of the Functional Group that the Data Segment belongs in.
• Handle - Returns the handle of the data segment.
• ID - Returns the identifier code of the Data Segment.
• InterchangeHandle - Returns the handle of the Interchange that the Data Segment belongs in.
• InterconnectHandle - Returns the handle of the Interconnect Mailbag that the Data Segment belongs in.
• LoopID - Returns the loop ID of the loop that the Data Segment is directly nested under.
• LoopInstance - Returns the instance of the loop that the data segment is directly nested under.
• LoopLevel - Returns the loop level that the Data Segment is in.
• LoopLevelID - Returns the loop ID of a loop level that the Data Segment is nested under.
• LoopRepeat - Returns the number of times the Data Segment and underlying segment groups have to repeat.
• LoopSection - Returns the loop section that the Data Segment is in.
• MaximumUse - Returns the Maximum Use property of a data segment
• MessageHandle - Returns a handle of the Message that the Data Segment belongs in.
• ObjectID - Returns the object ID of a data segment.
• Ordinal - Returns the ordinal position of the Data Segment.
• Position - Returns the position of the Data Segment.
• PositionInSet - Returns the position number count of the Data Segment within the ASC/X12 Transaction Set or UN/EDIFACT Message.
• Reference - Returns the reference code of the Data Segment.
• ReleaseIndicator - Returns the Release Indicator.
• RepeatSeparator - Returns the repeating element separator string that separates the repeating data.
• Requirement - Returns the requirement of the Data Segment.
• SegmentBuffer - Returns the data segment raw string as retrieved from the document.
• SegmentLineCount - Returns the count of segments in an EDI file.
• SegmentTerminator - Returns the Data Segment terminator.
• TransactionSetHandle - Returns the handle of the Transaction Set that the Data Segment is in.
• UsageInstance - Returns the usage instance of a data segment elements in the data segment.
• UserRequirement - Returns the user requirement of the Data Segment.