Interface IMessageLocation

Used with messages that link to a document location to provide a mechanism to retrieve the corresponding positions in the bilingual content model.

Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IMessageLocation

Properties

CharactersIntoParagraph

Number of characters from the start of the paragraph; used when translating and persisting message locations. The bilingual paragraph location may be calculated from this.

Declaration

int CharactersIntoParagraph { get; set; }

Property Value

Type	Description
System.Int32

Remarks

A value of -1 implies this property has not been set.

CharactersIntoSegment

Number of characters from the start of the segment if the location is inside a segment. Used when translating and persisting message locations. The bilingual paragraph location may be calculated from this.

Declaration

int CharactersIntoSegment { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This value is only valid if the SegmentId value is not null. A value of -1 implies that this property has not been set.

FileId

Id of the file that the location refers to, or null if none.

Declaration

FileId? FileId { get; set; }

Property Value

Type	Description
System.Nullable<FileId>

LocationDescription

Textual description of the location. This is used for messages for which a link to the actual location in the document cannot be provided (e.g. if they refer to a different file or if no actual document location could be determined).

Declaration

string LocationDescription { get; set; }

Property Value

Type	Description
System.String

ParagrahUnitId

Id of the paragraph unit that the location refers to, or null if none.

Declaration

ParagraphUnitId? ParagrahUnitId { get; set; }

Property Value

Type	Description
System.Nullable<ParagraphUnitId>

ParagraphLocation

Text location that the message refers to within the source or target paragraph, or null if none.

Declaration

TextLocation ParagraphLocation { get; set; }

Property Value

Type	Description
TextLocation

SegmentId

Id of the segment that the location refers to, or null if none.

Declaration

SegmentId? SegmentId { get; set; }

Property Value

Type	Description
System.Nullable<SegmentId>

SourceOrTarget

Indicates whether the location refers to the source or target.

Declaration

ContentRestriction SourceOrTarget { get; set; }

Property Value

Type	Description
ContentRestriction