Class SegmentReference
Serializable reference to a segment that can be used to reference a specific segment in a paragraph and file e.g. when processing content for preview.
Inheritance
System.Object
SegmentReference
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Sdl.FileTypeSupport.Framework.IntegrationApi
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public class SegmentReferenceConstructors
SegmentReference(FileId, ParagraphUnitId, SegmentId)
Construction from file, paragraph and segment ids
Declaration
public SegmentReference(FileId fileId, ParagraphUnitId paraId, SegmentId segId)Parameters
| Type | Name | Description |
|---|---|---|
| FileId | fileId | |
| ParagraphUnitId | paraId | |
| SegmentId | segId |
Properties
FileId
File id for the file that the segment reference applies to
Declaration
public FileId FileId { get; set; }Property Value
| Type | Description |
|---|---|
| FileId |
ParagraphUnitId
Id of the paragraph unit that the segment reference applies to
Declaration
public ParagraphUnitId ParagraphUnitId { get; set; }Property Value
| Type | Description |
|---|---|
| ParagraphUnitId |
SegmentId
Id of the segment that the reference applies to
Declaration
public SegmentId SegmentId { get; set; }Property Value
| Type | Description |
|---|---|
| SegmentId |
Methods
Equals(Object)
Considered equal if file, paragraph and segment ids match.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | obj |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
System.Object.Equals(System.Object)
GetHashCode()
Hash code is computed by combining file, paragraph unit and segment ids.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 |
Overrides
System.Object.GetHashCode()