Framework EDI Reference. Constants
Document Option ID Constants

Document Option ID Constants indicates what optional feature can be enabled or disabled in the ediDocument interface.

• OptDocument_LineFeed (0) – Indicates if the document to load contains Line Feeds to format the document. Default as disabled (0).
• OptDocument_BreakOnEmptyTran (4) – Indicates if the operation should stop for transaction sets that do not have data. Default as disabled (0).
• OptDocument_ServiceSegment (5) – Indicates if the UN/EDIFACT file contains a UNA service segment. Default as disabled (0).
• OptDocument_AutoDetect (7) – Indicates if the delimiters should be automatically detected. Applicable to X12 documents only. Default as enabled (1).
• OptDocument_EnforceUserRequirement (8) – Indicates if the document should enforce the implementation guideline. Operation can stop if the document does not completely follow the implementation guideline. Default as disabled (0).
• OptDocument_SuppressSyntaxRuleCheck (9) – Indicates if Syntax Rule checking should be suppressed. Default as disabled (1).
• OptDocument_VerifyCodes (10) – Indicates if the values of the data element codes should be verified against what is valid only for the data element according to the implementation guideline. Default as enabled (1).
• OptDocument_BreakOnWarning (11) – Indicates if the operation should stop for any kind of warnings reported.
• OptDocument_UseLocalTime (12) – Indicates if date and time stamp should use the local time as opposed to universal coordinated time (UTC). Defaults as disabled (0).
• OptDocument_MachineKeySet (13) – Indicates if the Cryptographic Service Providers' key containers should be stored as machine keys instead of user keys. Machine keys are stored in the HKEY_LOCAL_MACHINE registry instead of the default HKEY_CURRENT_USER for user keys.  This option should be enabled if key containers are to be created and/or accessed by applications accessing from a service or a user account that did not log on interactively.  Default as disabled(0).
• OptDocument_SemanticLevelNotify (14) - If enabled, this option generates an event that notifies the client each time the following semantic object event is encountered in the document.  Default is enabled(1).
  • Start of a transaction set/message.
  • End of a transaction set/message.
  • Start of a functional group.
  • End of functional group.
  • Start of an interchange.
  • End of an interchange.
  • End of a loop.
• OptDocument_ReadOnlyMode (1001) – Indicates if processing the document should be in Read-Only mode. Default as disabled (0).
• OptDocument_MultiTasking (1002) – Indicates if multi-tasking should be implemented. Default as disabled(0).
• OptDocument_EnableSecurity (1003) – NOT YET IMPLEMENTED.
• OptDocument_PictureSaveMemCopy (1004) - This option indicates if the picture that is being assigned to a data element should be temporarily stored in memory, or in a file before it is imported into the data element value.  Assigning a picture to the data element, seems to behave inconsistently if the client is accessing Framework EDI between COM or the .NET interop.  
  • If accessing through COM, this property should be disabled (0).
  • If accessing as .NET interop, this property should be enabled (1).

  Default is enabled (1).

• OptDocument_Output_ElmTruncateValue (1005) - Specifies that the output of the data element's alphanumeric value is truncated to satisfy maximum length requirement.  Default is enabled (1).
• OptDocument_Output_ElmPadTrailingSpaces (1006) - Specifies that the output of data element's alphanumeric value is padded with trailing spaces to satisfy minimum length requirement.  Default is enabled (1).
• OptDocument_Output_ElmPadLeadingZeros (1007) - Specifies that output of the data element's numeric value is padded with leading zeros to satisfy minimum length requirement.  Default is enabled (1).
• OptDocument_Output_ElmValueTrimRight (1008) - Specifies that output of the data element's value has its trailing spaces trimmed.  Default is disabled (0).

The Option property in the ediDocument enables or disables the feature indicated by the Option ID Constants.  To enable the feature, set the option to 1; to disable set the option to 0.