Show / Hide Table of Contents

Class PhysicalStructure

Describes the physical structure of a RecordLayout.

Inheritance
object
NotificationObject
IdentifiableBase
VersionableBase
DescribableBase
PhysicalStructure
Implements
INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable
Inherited Members
DescribableBase.ItemName
DescribableBase.Label
DescribableBase.Description
VersionableBase.Accept(IVersionableVisitor)
VersionableBase.IsDirty
VersionableBase.IsPublished
VersionableBase.ChildrenDereferenced
VersionableBase.IsPopulated
VersionableBase.Version
VersionableBase.VersionDate
VersionableBase.VersionResponsibility
VersionableBase.VersionRationale
VersionableBase.CompositeId
VersionableBase.OtherMaterials
VersionableBase.BasedOn
VersionableBase.SucceededBy
VersionableBase.Attachments
VersionableBase.ThumbnailImageUri
VersionableBase.BannerImageUri
VersionableBase.DisableChangeTracking
VersionableBase.RemoveChildHelper(IVersionable, params IList[])
VersionableBase.AddChild(IVersionable)
VersionableBase.ChildTypesAccepted
VersionableBase.TryReplaceChild<T>(Func<T>, Action<T>, IdentifierTriple, IVersionable)
VersionableBase.ToString()
IdentifiableBase.DefaultAgencyId
IdentifiableBase.AgencyId
IdentifiableBase.Identifier
IdentifiableBase.UserIds
IdentifiableBase.CustomFields
IdentifiableBase.UserAttributes
IdentifiableBase.GetUserIdValue(string)
IdentifiableBase.RemoveChildHelper(IdentifierTriple, params IList[])
NotificationObject.PropertyChanged
NotificationObject.RaisePropertyChanged(string)
NotificationObject.OnPropertyChanged(string)
NotificationObject.ResumePropertyEvents()
NotificationObject.SuspendPropertyEvents()
NotificationObject.PropertyEventsSuspended
NotificationObject.PropagateChildChanges(INotifyCollectionChanged, string)
NotificationObject.WatchProperty(INotifyPropertyChanged, string)
NotificationObject.WatchCollection(INotifyCollectionChanged, string)
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Namespace: Algenta.Colectica.Model.Ddi
Assembly: Algenta.Colectica.Model.Ddi.dll
Syntax
public class PhysicalStructure : DescribableBase, INotifyPropertyChanged, IVersionable, IIdentifiable, IHasCustomFields, IDescribable, IVisitable

Constructors

PhysicalStructure()

Initializes a new instance of the PhysicalStructure class.

Declaration
public PhysicalStructure()

Properties

DefaultDecimalPositions

Gets or sets the number of decimal places for DataItems without an explicit decimal separator.

Declaration
public int? DefaultDecimalPositions { get; set; }
Property Value
Type Description
int?

The default decimal positions.

DefaultDecimalSeparator

Gets or sets the decimal separator used by DataItems.

Declaration
public char DefaultDecimalSeparator { get; set; }
Property Value
Type Description
char

The default decimal separator.

DefaultDelimiter

Gets or sets the default delimiter used to separate DataItems in a delimited file.

Declaration
public string DefaultDelimiter { get; set; }
Property Value
Type Description
string

The default delimiter.

DefaultDigitGroupSeparator

Gets or sets the digit group separator used by DataItems.

Declaration
public char DefaultDigitGroupSeparator { get; set; }
Property Value
Type Description
char

The default digit group separator.

DisplayLabel

Gets the display label.

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

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

Format

Gets or sets the format (e.g., delimited file, fixed format file, SAS save file).

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

The format.

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
VersionableBase.ItemType

RecordStructures

Gets the record structures, which determine the LogicalRecord held in this PhysicalStructure.

Declaration
public ObservableCollection<GrossRecordStructure> RecordStructures { get; }
Property Value
Type Description
ObservableCollection<GrossRecordStructure>

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
VersionableBase.GetChildren()

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
int

The number of children removed from the item.

Overrides
VersionableBase.RemoveChild(IdentifierTriple)
Exceptions
Type Condition
ArgumentNullException

child

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
int

The number of children replaced.

Overrides
VersionableBase.ReplaceChild(IdentifierTriple, IVersionable)
Exceptions
Type Condition
ArgumentNullException

child

WatchProperties()

Watch for property changed events

Declaration
protected override void WatchProperties()
Overrides
DescribableBase.WatchProperties()

Implements

INotifyPropertyChanged
IVersionable
IIdentifiable
IHasCustomFields
IDescribable
IVisitable

Extension Methods

VersionableCustomFieldExtensions.GetCustomFieldMultilingualStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldStringValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.GetCustomFieldUriValue(IHasCustomFields, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, MultilingualString, string)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, IVersionable)
VersionableCustomFieldExtensions.SetCustomField(IHasCustomFields, string, string)
Extensions.GetDdi32FragmentRepresentation(IVersionable, Ddi32Serializer)
Extensions.GetDdi33FragmentRepresentation(IVersionable, Ddi33Serializer)
Extensions.GetDdiFragmentRepresentation(IVersionable, DDIWorkflowSerializer, XmlDocument)
Extensions.GetMultilingualStrings(IVersionable)
NamingHelper.GetBaseFileNameForItem(IVersionable)
VersionableExtensions.GetHeader(IVersionable, bool)
VersionableExtensions.GetMetadata(IVersionable)
VersionableExtensions.GetUserAttribute(IVersionable, string)
VersionableExtensions.GetUserAttributeInt(IVersionable, string)
VersionableExtensions.SetUserAttribute(IVersionable, string, string)
VersionableUserIdExtensions.SetUserId(IVersionable, string, string)
In this article
Back to top Generated by DocFX