Class RecordLayout

Represents the layout of a data record.

Inheritance
System.Object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
RecordLayout
Inherited Members
Algenta.Colectica.Model.VersionableBase.TryReplaceChild<T>(Func<>, Action<>, Algenta.Colectica.Model.Utility.IdentifierTriple, Algenta.Colectica.Model.IVersionable)
Algenta.Colectica.Model.NotificationObject.RaisePropertyChanged<T>(Expression<>)
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class RecordLayout : DescribableBase, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable, ISummaryText
Remarks

This class implements IDescribable just for Colectica Portal. RecordLayout does not have name, label, and description fields in DDI 3 serialization.

Constructors

RecordLayout()

Initializes a new instance of the RecordLayout class.

Declaration
public RecordLayout()

Properties

ArrayBase

Gets or sets the array base for any arrays used in the definition (that is, whether the first value is in position 0 or 1).

Declaration
public int ArrayBase { get; set; }
Property Value
Type Description
System.Int32

CharacterSet

Gets or sets the character set used in the data file (e.g., ASCII, UTF-8, EBCDIC).

Declaration
public CodeValue CharacterSet { get; set; }
Property Value
Type Description
CodeValue

DataItems

Gets the data items included in the record. The DataItems include references to the logical Variable descriptions of the data.

Declaration
public ObservableCollection<DataItem> DataItems { get; }
Property Value
Type Description
ObservableCollection<DataItem>

DisplayLabel

Gets the display label.

Declaration
public override string DisplayLabel { get; }
Property Value
Type Description
System.String
Overrides
Remarks

The display label returns text to be displayed in a user interface or in generated documentation.

IsFirstRowHeader

Gets or sets a value indicating whether the first row of data is a header.

Declaration
public bool IsFirstRowHeader { get; set; }
Property Value
Type Description
System.Boolean

true if the first row of data is a header; otherwise, false.

ItemType

Gets the universally unique identifier representing the item's type.

Declaration
public override Guid ItemType { get; }
Property Value
Type Description
Guid

The identifier representing the item's type.
Overrides

PhysicalStructure

Gets or sets the physical structure.

Declaration
public PhysicalStructure PhysicalStructure { get; set; }
Property Value
Type Description
PhysicalStructure

Summary

Gets the summary text.

Declaration
public MultilingualString Summary { get; }
Property Value
Type Description
MultilingualString
Implements

Methods

GetChildren()

Gets the identifiers of the item's children.

Declaration
public override ChildItemCollection GetChildren()
Returns
Type Description
ChildItemCollection

The identifiers of the item's children.
Overrides

RemoveChild(IdentifierTriple)

Removes the specified child.

Declaration
public override int RemoveChild(IdentifierTriple child)
Parameters
Type Name Description
IdentifierTriple child

The child to be removed.
Returns
Type Description
System.Int32

The number of children removed from the item.
Overrides

ReplaceChild(IdentifierTriple, IVersionable)

Replaces the child with the specified identifier with the provided item.

Declaration
public override int ReplaceChild(IdentifierTriple toReplace, IVersionable child)
Parameters
Type Name Description
IdentifierTriple toReplace

The identifier of the child to replace.
IVersionable child

The new child.
Returns
Type Description
System.Int32

The number of children replaced.
Overrides

Extension Methods