IParagraph Interface

Container for the source or target content in a IParagraphUnit; this often corresponds to a paragraph of localizable content in one language.

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 IParagraph : IAbstractMarkupDataContainer, 
	IList<IAbstractMarkupData>, ICollection<IAbstractMarkupData>, IEnumerable<IAbstractMarkupData>, 
	IEnumerable, ISupportsUniqueId, ICloneable

Public Interface IParagraph
	Inherits IAbstractMarkupDataContainer, IList(Of IAbstractMarkupData), ICollection(Of IAbstractMarkupData), 
	IEnumerable(Of IAbstractMarkupData), IEnumerable, ISupportsUniqueId, ICloneable

public interface class IParagraph : IAbstractMarkupDataContainer, 
	IList<IAbstractMarkupData^>, ICollection<IAbstractMarkupData^>, IEnumerable<IAbstractMarkupData^>, 
	IEnumerable, ISupportsUniqueId, ICloneable

type IParagraph =  
    interface
        interface IAbstractMarkupDataContainer
        interface IList<IAbstractMarkupData>
        interface ICollection<IAbstractMarkupData>
        interface IEnumerable<IAbstractMarkupData>
        interface IEnumerable
        interface ISupportsUniqueId
        interface ICloneable
    end

The IParagraph 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.)
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only. (Inherited from ICollectionIAbstractMarkupData.)
	IsSource	True if the paragraph is the Source of the Parent.
	IsTarget	True if the paragraph is the Target of the Parent.
	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	The parent paragraph unit this paragraph belongs to
	TextDirection	The text direction of the paragraph. This directionality overrides any document-level directionality unless it is set to Inherit.
	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
	Add	Adds an item to the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	Clear	Removes all items from the ICollectionT. (Inherited from ICollectionIAbstractMarkupData.)
	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.)
	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

A paragraph is a markup data container, but does not implement IAbstractMarkupData. It acts as the root container for the source or target content in a paragraph.

Paragraphs are only used as Source or Target members; they are never created as standalone objects.

The IsSource and IsTarget properties can be used to quickly find out if this is the source or target part of the Parent paragraph unit.

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/