ICommentMarker Interface

Comments associated with specific content inside markup data

Namespace: Sdl.FileTypeSupport.Framework.BilingualApi
Assembly: Sdl.FileTypeSupport.Framework.Core (in Sdl.FileTypeSupport.Framework.Core.dll) Version: 1.0.0.0 (1.0.2551.0)

Syntax

C++

Copy

public interface ICommentMarker : IAbstractMarker, 
	IAbstractMarkupData, ICloneable, IAbstractMarkupDataContainer, IList<IAbstractMarkupData>, 
	ICollection<IAbstractMarkupData>, IEnumerable<IAbstractMarkupData>, IEnumerable

Public Interface ICommentMarker
	Inherits IAbstractMarker, IAbstractMarkupData, ICloneable, IAbstractMarkupDataContainer, 
	IList(Of IAbstractMarkupData), ICollection(Of IAbstractMarkupData), IEnumerable(Of IAbstractMarkupData), 
	IEnumerable

public interface class ICommentMarker : IAbstractMarker, 
	IAbstractMarkupData, ICloneable, IAbstractMarkupDataContainer, IList<IAbstractMarkupData^>, 
	ICollection<IAbstractMarkupData^>, IEnumerable<IAbstractMarkupData^>, IEnumerable

type ICommentMarker =  
    interface
        interface IAbstractMarker
        interface IAbstractMarkupData
        interface ICloneable
        interface IAbstractMarkupDataContainer
        interface IList<IAbstractMarkupData>
        interface ICollection<IAbstractMarkupData>
        interface IEnumerable<IAbstractMarkupData>
        interface IEnumerable
    end

The ICommentMarker type exposes the following members.

Properties

	Name	Description
	AllSubItems	An iterator that can be used to iterate over all child items - including sub-items - in the container. (Inherited from IAbstractMarkupDataContainer.)
	CanBeSplit	Indicates whether it is possible to split this container into different parts by calling the Split(Int32) method. (Inherited from IAbstractMarkupDataContainer.)
	Comments	The actual comments for the content that this container spans
	IndexInParent	The index of this item in its parent container (if any). (Inherited from IAbstractMarkupData.)
	Locations	Iterator for all possible locations in the collection and its sub-collections (Inherited from IAbstractMarkupDataContainer.)
	Parent	When this item is inside a markup data container, this property provides access to the parent container. (Inherited from IAbstractMarkupData.)
	ParentParagraph	Convenient accessor to the source or target paragraph container that the item appears in. (Inherited from IAbstractMarkupData.)

Top

Methods

	Name	Description
	AcceptVisitor	Part of the visitor pattern implementation for markup data. This method is overridden in each leaf implementation. The implementation should call the Visit... method on the visitor corresponding to their object type, passing themselves (i.e. this) as the parameter. Objects that contain other objects (e.g. implementations of ISegment or IOtherMarker) should NOT apply the visitor to their content items. It must be left to the visitor implementation to 'decide' whether the visitor 'wants' to visit the sub-items of a node. (Inherited from IAbstractMarkupData.)
	Find(PredicateIAbstractMarkupData)	Returns the first item that matches the specified predecate. The iteration is performed over all items and sub-items in this collection and all sub-collections until the item is located. (Inherited from IAbstractMarkupDataContainer.)
	Find(PredicateLocation)	Returns the first location that matches the specified predecate. The iteration is performed over all locations in this collection and all sub-collections until the element is located. (Inherited from IAbstractMarkupDataContainer.)
	Find(Location, PredicateLocation)	Returns the first location that matches the specified predecate, starting at a specific location. (Inherited from IAbstractMarkupDataContainer.)
	ForEachSubItem	Execute the specified action on each item and (recursively) each sub-item in this container. (Inherited from IAbstractMarkupDataContainer.)
	GetLocationsFrom	Enumerator for locations starting from a specific location (Inherited from IAbstractMarkupDataContainer.)
	MoveAllItemsTo(IAbstractMarkupDataContainer)	Moves all items from this container into another one. (Inherited from IAbstractMarkupDataContainer.)
	MoveAllItemsTo(IAbstractMarkupDataContainer, Int32)	Moves all items from this container to a specific location in another container. (Inherited from IAbstractMarkupDataContainer.)
	MoveItemsTo(IAbstractMarkupDataContainer, Int32, Int32)	Moves a number of items from this container into another one. (Inherited from IAbstractMarkupDataContainer.)
	MoveItemsTo(IAbstractMarkupDataContainer, Int32, Int32, Int32)	Moves a number of items from this container into a specific location in another one. (Inherited from IAbstractMarkupDataContainer.)
	RemoveFromParent	Removes this node from its parent container (if any). (Inherited from IAbstractMarkupData.)
	Split	Splits this container in two. After the split, this object will hold all items with index lower than the splitBeforeItemIndex parameter. The returned object is a clone of this object, which contains all other items. (Inherited from IAbstractMarkupDataContainer.)

Top

Remarks

The comments refer to the content inside the container

It is possible to attach the same comments to multiple locations by creating multiple comment markers that reference the same Comments instance. (Just call CreateCommentMarker(ICommentProperties), and pass in the same properties instance.)

Reference

Sdl.FileTypeSupport.Framework.BilingualApi Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/