Interface ISubSegmentProperties

Sub-segments are, for example, localizable tag attributes. During conversion to bilingual format, every sub-segment will end up in its own paragraph unit.

The properties StartOffset and Length are required in order to put the translations back into the right places.

Inherited Members

System.ICloneable.Clone()

Namespace: Sdl.FileTypeSupport.Framework.NativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface ISubSegmentProperties : ICloneable

Properties

Contexts

Context information for the sub-segment.

Declaration

IContextProperties Contexts { get; set; }

Property Value

Type	Description
IContextProperties

Remarks

Can be null if no explicit context information is associated with this sub-segment.

During conversion from native to bilingual, any contexts in this collection get propagated to the paragraph unit that contains the actual localizable content of the sub-segment. If this property is null, a default "Tag content" context is created to let users know that they are looking at content that appears inside a tag.

In addition, during conversion from native to bilingual a sub-segment reference context is added to this collection in order to facilitate navigation from the sub-segment paragraph unit to the paragraph unit that contains the actual localizable content. All contexts added by the framework during native to bilingual conversion are removed during conversion from bilingual back to native format.

Length

Number of characters that the sub-segment spans

Declaration

int Length { get; set; }

Property Value

Type	Description
System.Int32

StartOffset

The index of the first character of the sub-segment in the text where it appears.

Declaration

int StartOffset { get; set; }

Property Value

Type	Description
System.Int32