ediDocument

The ediDocument object is the topmost creatable object for Framework EDI. It provides general services for processing EDI documents as well as access to underlying interfaces.

Methods

• Cancel - Cancels the process of loading a document.
• Close - Closes and cleans up the object
• CreateInterchange - Creates a new Interchange.
• CreateInterconnectMailbag - Creates an Interconnect Mailbag object.
• DllApiCall - Calls an exported function of an external DLL component.
• DllNotifyDocuments - Notifies Framework EDI clients of information passed from an external DLL.
• GetAcknowledgment - Returns the Acknowledgment object.
• GetCommentTypes - Returns the Comment Types object.
• GetDataSegmentByHandle - Gets the data segment by passing the handle of the data segment.
• GetEdiString - Gets the entire content of the EDI document in a string
• GetMailDocument - Gets the mail document object.
• GetPerformance - Returns the Performance object.
• GetSchemas - Returns the Schemas object.
• GetSecurities - Gets the Securities object.
• GetSyntaxLevels – Gets the Syntax Levels object.
• GetTransports - Returns the Transports object.
• GetWarnings - Returns the Warnings object.
• GetXmlDocument - Gets the XML document object.
• ImportSchema - Imports a schema file or Standard Reference Library version.
• LoadEdi - Loads an EDI document.
• LoadEdiString - Loads an EDI string.
• LoadSchema - Specifies a schema or Standard Reference Library version to load.
• New - Begins a new document without having to reload existing implementation guideline schemas.
• PutEdiString - Called multiple times to build the EDI text internally as a string.
• ReadNextDataSegment - Returns the next data segment that contain unverified data from the document.
• Save - Saves the EDI document to an external file.
• WriteTreeHierarchy - Writes out the hierarchy structure of the data segments that make up the EDI document to an external file.

Properties

• CompositeTerminator - Sets or gets the component element terminator used by the document.
• CursorType - Sets or gets the cursor type.
• DecimalNotation - Sets or gets the decimal notation used by the document.
• DllNotifyEnable - Enables a document to receive a notification from an external DLL.
• ElementTerminator - Sets or gets the data element terminator used by the document.
• FirstDataSegment - Returns the first data segment of the document.
• FirstInterchange - Returns the first Interchange of the document.
• FirstInterconnectMailbag - Returns the first InterconnectMailbag of the document.
• InterchangeCount - Returns the number of Interchanges in the document.
• InterconnectCount - Returns the number of InterconnectMailbags in the document.
• IsEdifact - Indicates if the document loaded follows the standard of the UN/EDIFACT control agency.
• IsX12 - Indicates if the document loaded follows the standard of the ASC/X12 control agency.
• NextDataSegment - Returns the next data segment of the document.
• Option - Sets or Gets an option.
• Property - Sets or Gets a property of the document.
• ReleaseIndicator - Sets or gets the release indicator used by the document.
• RepeatSeparator - Sets or gets the repeating element separator to be used in the EDI document.
• SegmentTerminator - Sets or gets the segment terminator used by the document.