Class MarkupDataContainer

A MarkupData element that can hold other MarkupData elements.

Inheritance

System.Object

ExtensionDataContainer

MetadataContainer

MarkupData

MarkupDataContainer

AnnotationContainer

FeedbackContainer

LockedContentContainer

Paragraph

RevisionContainer

Segment

TagPair

Implements

System.IEquatable<MetadataContainer>

ICloneable<MarkupData>

System.IEquatable<MarkupData>

Inherited Members

MarkupData.AcceptVisitor(BcmVisitor)

MarkupData.Id

MarkupData.Type

MarkupData.Parent

MarkupData.ParentFragment

MarkupData.ParentParagraph

MarkupData.ParentParagraphUnit

MarkupData.Ancestors

MarkupData.ParentSegment

MarkupData.IsContainer

MarkupData.IndexInParent

MetadataContainer.GetMetadata(String)

MetadataContainer.SetMetadata(String, String)

MetadataContainer.Equals(MetadataContainer)

MetadataContainer.ShouldSerialize_metadata()

MetadataContainer.Metadata

ExtensionDataContainer.ExtensionData

Namespace: Sdl.Core.Bcm.BcmModel

Assembly: Sdl.Core.Bcm.BcmModel.dll

Syntax

public abstract class MarkupDataContainer : MarkupData, ICloneable<MarkupData>

Constructors

MarkupDataContainer()

Initializes a new instance of the MarkupDataContainer class.

Declaration

protected MarkupDataContainer()

MarkupDataContainer(String)

Initializes a new instance of the MarkupDataContainer class.

Declaration

protected MarkupDataContainer(string id)

Parameters

Type	Name	Description
System.String	id	The identifier.

Fields

AutoClonedTagPairKey

Metadata key, marking thi instance as cloned (duplicated) during conversion from native formats.

Declaration

public const string AutoClonedTagPairKey = "SDL:AutoCloned"

Field Value

Type	Description
System.String

Properties

AllSubItems

All the MarkupData items in the subtree, in depth-first order.

Declaration

public IEnumerable<MarkupData> AllSubItems { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<MarkupData>

Children

The container's direct children.

Declaration

public IReadOnlyCollection<MarkupData> Children { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyCollection<MarkupData>

Count

Gets the number of children of this container.

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32	The number of children of this container.

Item[Int32]

Gets or sets the MarkupData at the specified index.

Declaration

public MarkupData this[int index] { get; set; }

Parameters

Type	Name	Description
System.Int32	index	The index.

Property Value

Type	Description
MarkupData	The MarkupData.

Methods

Add(MarkupData)

Adds a new MarkupData to the container.

Declaration

public MarkupDataContainer Add(MarkupData markupData)

Parameters

Type	Name	Description
MarkupData	markupData	The item to be added.

Returns

Type	Description
MarkupDataContainer	The container after the change.

Add(IEnumerable<MarkupData>)

Adds a new MarkupData to the container.

Declaration

public MarkupDataContainer Add(IEnumerable<MarkupData> range)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<MarkupData>	range	The range of MarkupData items to be added.

Returns

Type	Description
MarkupDataContainer	The container after the change.

Clear()

Removes all the items from this container. Sets the previous children Parent property to null.

Declaration

public void Clear()

Clone()

Clones the item to a new MarkupData.

Declaration

public override MarkupData Clone()

Returns

Type	Description
MarkupData	A deep clone of this instance.

Overrides

MarkupData.Clone()

CloneWithoutChildren()

Creates a clone of this instance, without any children elements.

Declaration

public virtual MarkupDataContainer CloneWithoutChildren()

Returns

Type	Description
MarkupDataContainer	A clone of this instance, without any children elements.

Equals(MarkupData)

Indicates whether the current object is equal to another object of the same type.

Declaration

public override bool Equals(MarkupData other)

Parameters

Type	Name	Description
MarkupData	other	An object to compare with this object.

Returns

Type	Description
System.Boolean	true if the current object is equal to the other parameter; otherwise, false.

Overrides

MarkupData.Equals(MarkupData)

Equals(MarkupDataContainer)

Equalses the specified other.

Declaration

public virtual bool Equals(MarkupDataContainer other)

Parameters

Type	Name	Description
MarkupDataContainer	other	The other.

Returns

Type	Description
System.Boolean

Equals(Object)

Performs a deep-equals comparison.
System.Object.Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Overrides

MarkupData.Equals(Object)

GetAllChildren(Func<MarkupData, Boolean>)

Finds all the MarkupData items in the subtree which satisfy a specific condition, in depth-first order.

Declaration

public IEnumerable<MarkupData> GetAllChildren(Func<MarkupData, bool> condition)

Parameters

Type	Name	Description
System.Func<MarkupData, System.Boolean>	condition

Returns

Type	Description
System.Collections.Generic.IEnumerable<MarkupData>

GetAllChildren<T>(Func<T, Boolean>)

Finds all the MarkupData items in the subtree which satisfy a specific condition, in depth-first order.

Declaration

public IEnumerable<T> GetAllChildren<T>(Func<T, bool> condition)
    where T : MarkupData

Parameters

Type	Name	Description
System.Func<T, System.Boolean>	condition

Returns

Type	Description
System.Collections.Generic.IEnumerable<T>

Type Parameters

Name	Description
T

GetEnumerator()

Gets an System.Collections.Generic.IEnumerator<> for the container's children.

Declaration

public IEnumerator<MarkupData> GetEnumerator()

Returns

Type	Description
System.Collections.Generic.IEnumerator<MarkupData>	An System.Collections.Generic.IEnumerator<> instance enumerating the container's children.

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for this instance.

Overrides

MarkupData.GetHashCode()

Insert(Int32, MarkupData)

Inserts a new MarkupData into the container.

Declaration

public MarkupDataContainer Insert(int index, MarkupData markupData)

Parameters

Type	Name	Description
System.Int32	index	The position where the item should be inserted.
MarkupData	markupData	The item to be inserted.

Returns

Type	Description
MarkupDataContainer	The container after the change.

MoveToContainer(MarkupDataContainer, Int32, Int32, Int32)

Moves the children of this container to another MarkupDataContainer instance.

Declaration

public void MoveToContainer(MarkupDataContainer target, int sourceIndex, int targetIndex, int count)

Parameters

Type	Name	Description
MarkupDataContainer	target	The target MarkupDataContainer.
System.Int32	sourceIndex	Index in the source container, from where to start moving elements.
System.Int32	targetIndex	Index in the target container, where the elements should be inserted.
System.Int32	count	Number of elements to be moved.

OnDeserialized()

Declaration

protected virtual void OnDeserialized()

Remove(MarkupData)

Removes a MarkupData item from the container.

Declaration

public MarkupDataContainer Remove(MarkupData markupData)

Parameters

Type	Name	Description
MarkupData	markupData	The item to be removed.

Returns

Type	Description
MarkupDataContainer	The container after the changes.

ToString()

Converts to string.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents this instance.

UniqueClone()

Creates clone of the current object, with a new unique Id.

Declaration

public override MarkupData UniqueClone()

Returns

Type	Description
MarkupData	A clone with a new unique Id.

Overrides

MarkupData.UniqueClone()

Implements

System.IEquatable<>

ICloneable<T>

System.IEquatable<>

See Also

MarkupData