ITagPair Interface

ITagPair Interface

A pair of tags (i.e. start and end) in the bilingual content model, with the content enclosed by the tag pair

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

Syntax

C++

Copy

public interface ITagPair : IAbstractTag, 
	IAbstractDataContent, IAbstractMarkupData, ICloneable, IAbstractMarkupDataContainer, IList<IAbstractMarkupData>, 
	ICollection<IAbstractMarkupData>, IEnumerable<IAbstractMarkupData>, IEnumerable, 
	ISupportsUniqueId

Public Interface ITagPair
	Inherits IAbstractTag, IAbstractDataContent, IAbstractMarkupData, ICloneable, 
	IAbstractMarkupDataContainer, IList(Of IAbstractMarkupData), ICollection(Of IAbstractMarkupData), 
	IEnumerable(Of IAbstractMarkupData), IEnumerable, ISupportsUniqueId

public interface class ITagPair : IAbstractTag, 
	IAbstractDataContent, IAbstractMarkupData, ICloneable, IAbstractMarkupDataContainer, IList<IAbstractMarkupData^>, 
	ICollection<IAbstractMarkupData^>, IEnumerable<IAbstractMarkupData^>, IEnumerable, 
	ISupportsUniqueId

type ITagPair =  
    interface
        interface IAbstractTag
        interface IAbstractDataContent
        interface IAbstractMarkupData
        interface ICloneable
        interface IAbstractMarkupDataContainer
        interface IList<IAbstractMarkupData>
        interface ICollection<IAbstractMarkupData>
        interface IEnumerable<IAbstractMarkupData>
        interface IEnumerable
        interface ISupportsUniqueId
    end

The ITagPair 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.)
	Count	Gets the number of elements contained in the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	EndTagProperties	The tag properties communicated from the native file processing components that refer to the end tag of the paired tags
	EndTagRevisionProperties	Revision information directly associated with the end tag, or null if none
	HasSubSegmentReferences	True if there is one or more SubSegments for the tag. (Inherited from IAbstractTag.)
	IndexInParent	The index of this item in its parent container (if any). (Inherited from IAbstractMarkupData.)
	IsEndTagGhost	When true, the end tag of the tag pair has ghost status. Ghost tags occur when either the start tag or the end tag of a tag pair has been deleted. Such operations would leave the tag pair in an invalid state until either the remaining start or end tag has been removed too (provided that the entire tag pair can be deleted properly). SDL Trados Studio supports this behavior in the editor by leaving the tag pair in place until both start and end tags have been deleted. While only one tag of a pair has been deleted, the "deleted" tag is temporarily marked as a (transparent) "ghost" tag, but retains its position.
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from ICollectionIAbstractMarkupData.)
	IsStartTagGhost	When true, the start tag of the tag pair has ghost status. Ghost tags occur when either the start tag or the end tag of a tag pair has been deleted. Such operations would leave the tag pair in an invalid state until either the remaining start or end tag has been removed too (provided that the entire tag pair can be deleted properly). SDL Trados Studio supports this behavior in the editor by leaving the tag pair in place until both start and end tags have been deleted. While only one tag of a pair has been deleted, the "deleted" tag is temporarily marked as a (transparent) "ghost" tag, but retains its position.
	Item	Gets or sets the element at the specified index. (Inherited from IListIAbstractMarkupData.)
	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.)
	StartTagProperties	The tag properties communicated by the native file processing components that refer to the start tag of the paired tags
	StartTagRevisionProperties	Revision information that is directly associated with the start tag, or null if none
	SubSegments	Information on any localizable content inside this tag (Inherited from IAbstractTag.)
	TagProperties	Common properties of tag information as determined by the native file type processors (Inherited from IAbstractTag.)
	UniqueId	The Unique ID associated with an object may be used by implementations during operations such as segmentation (Inherited from ISupportsUniqueId.)

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.)
	Add	Adds an item to the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	AddSubSegmentReference	Appends a sub-segment reference to the list of sub-segments. (Inherited from IAbstractTag.)
	AddSubSegmentReferences	Appends a set of sub-segment references. (Inherited from IAbstractTag.)
	Clear	Removes all items from the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	ClearSubSegmentReferences	Removes all sub-segment references from the tag. (Inherited from IAbstractTag.)
	Clone	Creates a new object that is a copy of the current instance. (Inherited from ICloneable.)
	Contains	Determines whether the ICollectionT contains a specific value. (Inherited from ICollectionIAbstractMarkupData.)
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index. (Inherited from ICollectionIAbstractMarkupData.)
	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.)
	GetEnumerator	Returns an enumerator that iterates through the collection. (Inherited from IEnumerableIAbstractMarkupData.)
	GetLocationsFrom	Enumerator for locations starting from a specific location (Inherited from IAbstractMarkupDataContainer.)
	IndexOf	Determines the index of a specific item in the IListT. (Inherited from IListIAbstractMarkupData.)
	Insert	Inserts an item to the IListT at the specified index. (Inherited from IListIAbstractMarkupData.)
	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.)
	Remove	Removes the first occurrence of a specific object from the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	RemoveAt	Removes the IListT item at the specified index. (Inherited from IListIAbstractMarkupData.)
	RemoveFromParent	Removes this node from its parent container (if any). (Inherited from IAbstractMarkupData.)
	RemoveSubSegmentReference	Removes the specified sub-segment reference. (Inherited from IAbstractTag.)
	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

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/