ERPConnect.Idocs.IdocSegment

Namespace: ERPConnect.Idocs
Assembly: ERPConnectStandard20.dll

Represent a single IDoc segment with all its child segments

public class IdocSegment

Inheritance

object ← IdocSegment

Inherited Members

object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Constructors

IdocSegment()

public IdocSegment()

Properties

ChildSegments

Collection of all segment that are child relation to the current segment

public IdocSegmentCollection ChildSegments { get; set; }

Property Value

IdocSegmentCollection

Description

A short description of the segment

public string Description { get; set; }

Property Value

string

Fields

Fields represent the values and other Properties of the fields that are contained in one segment

public IdocSegmentFieldCollection Fields { get; set; }

Property Value

IdocSegmentFieldCollection

HasChildren

True / false whether child segments are existing

public bool HasChildren { get; }

Property Value

bool

MaxOccur

Defines how often a segment can occur

public int MaxOccur { get; set; }

Property Value

int

SegmentName

The DDIC type for this segment

public string SegmentName { get; set; }

Property Value

string

SegmentType

The type name for this segment

public string SegmentType { get; set; }

Property Value

string

Methods

Clone()

Creates a cloned IdocSegment object

public IdocSegment Clone()

Returns

IdocSegment

A new IdocSegment object

ReadDataBuffer(int, int)

Returns a part of the data buffer of a given length and a given position

public string ReadDataBuffer(int Offset, int Length)

Parameters

Offset int

Offset where to read in the data buffer

Length int

Length of the string

Returns

string

A string that contains tha part of data buffer

ToString()

Returns a string for debugging purpose

public override string ToString()

Returns

string

-

WriteDataBuffer(string, int, int)

Writes as string at a given position into the Idoc data buffer

public void WriteDataBuffer(string Content, int Offset, int Length)

Parameters

Content string

The string to be written

Offset int

The offset in the buffer where the string should be placed

Length int

The length of the string