Class MarkupDataNodeIterator

Helper class to iterate over IMarkupDataNode nodes in the editor API.

Inheritance

System.Object

MarkupDataNodeIterator

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Sdl.DesktopEditor.EditorApi.Implementation

Assembly: Sdl.DesktopEditor.EditorApi.dll

Syntax

public class MarkupDataNodeIterator

Constructors

MarkupDataNodeIterator(IAbstractContainerNode)

Limit iteration to the specified container, start at the first node in the container.

Declaration

public MarkupDataNodeIterator(IAbstractContainerNode container)

Parameters

Type	Name	Description
IAbstractContainerNode	container	The bounding container

MarkupDataNodeIterator(IAbstractContainerNode, IAbstractNode)

Limit iteration to the specified container, start at a specified node (which should be in the container, but can be a sub-node).

Declaration

public MarkupDataNodeIterator(IAbstractContainerNode container, IAbstractNode from)

Parameters

Type	Name	Description
IAbstractContainerNode	container	The bounding container.
IAbstractNode	from	The first node to start from. This is typically a node somewhere inside the container.

MarkupDataNodeIterator(IAbstractContainerNode, IMarkupDataNode)

Limit iteration to the specified container, start at a specified markup data node (which should be in the container, but can be a sub-node).

Declaration

public MarkupDataNodeIterator(IAbstractContainerNode container, IMarkupDataNode from)

Parameters

Type	Name	Description
IAbstractContainerNode	container	The bounding container.
IMarkupDataNode	from	The first node to start from. This is typically a node somewhere inside the container.

MarkupDataNodeIterator(IAbstractNode)

Start at the specified node. Iterate until the end of all available content, including parent nodes.

Declaration

public MarkupDataNodeIterator(IAbstractNode from)

Parameters

Type	Name	Description
IAbstractNode	from	the position to start from, may or may not be a content node

MarkupDataNodeIterator(IAbstractNode, IAbstractContentNode)

Limit iteration to a specific end node. The iteration will stop at the upto node, which will not be returned as a markup node.

Declaration

public MarkupDataNodeIterator(IAbstractNode from, IAbstractContentNode upto)

Parameters

Type	Name	Description
IAbstractNode	from	The first node to start from. May or may not be a container.
IAbstractContentNode	upto	The node at which to stop. Will not be part of the content iterated over, and must be after the from node to be effective.

Properties

CurrentNode

The current markup data node, or null if none.

Declaration

public IMarkupDataNode CurrentNode { get; }

Property Value

Type	Description
IMarkupDataNode

Methods

Next()

Advance to the next markup data node.

Declaration

public bool Next()

Returns

Type	Description
System.Boolean	true if another markup data node was found; false if not or the end of the bounding container was reached.

NextTag()

Advance the iterator to the next markup data tag node.

Declaration

public bool NextTag()

Returns

Type	Description
System.Boolean	true when a tag has been found; false when the end of the bounding container is reached or there are no tags within the container.

Remarks

Useful when advancement to the next ITagPairContainerNode or IPlaceholderTagNode is required.

Previous()

Backs the iterator to the previous node.

Declaration

public bool Previous()

Returns

Type	Description
System.Boolean	true if the operation is successful; false if there is no preceding markup data node or the start of the bounding container is reached.

PreviousTag()

Backs the iterator to the previous markup data tag node.

Declaration

public bool PreviousTag()

Returns

Type	Description
System.Boolean	true when a tag has been found; false when the start of the bounding container is reached or there are no tags within the container.

Remarks

Useful when advancement to the previous ITagPairContainerNode or IPlaceholderTagNode is required.

Extension Methods

WindowsControlUtils.ForWindowFromFrameworkElement(Object, Action<Window>)