Class File

BCM data extracted from a native file.

Inheritance

object

ExtensionDataContainer

MetadataContainer

File

Implements

IEquatable<MetadataContainer>

ICloneable<File>

IEquatable<File>

Inherited Members

MetadataContainer.GetMetadata(string)

MetadataContainer.SetMetadata(string, string)

MetadataContainer.Equals(MetadataContainer)

MetadataContainer.ShouldSerialize_metadata()

MetadataContainer.Metadata

ExtensionDataContainer.ExtensionData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Namespace: Sdl.Core.Bcm.BcmModel

Assembly: Sdl.Core.Bcm.BcmModel.dll

Syntax

[DataContract]
public class File : MetadataContainer, IEquatable<MetadataContainer>, ICloneable<File>, IEquatable<File>

Constructors

File()

Public constructor.

Declaration

public File()

File(string)

Declaration

public File(string Id)

Parameters

Type	Name	Description
string	Id

Properties

CommentDefinitionIds

IDs of CommentDefinition used as file-level comments.

Declaration

[DataMember(Name = "commentDefinitionIds", EmitDefaultValue = false)]
public List<int> CommentDefinitionIds { get; set; }

Property Value

Type	Description
List<int>

DependencyFiles

Dependency files used for converting to and from native format.

Declaration

[DataMember(Name = "dependencyFiles", EmitDefaultValue = false)]
public List<DependencyFile> DependencyFiles { get; set; }

Property Value

Type	Description
List<DependencyFile>

FileTypeDefinitionId

The ID of the filter used for converting the file from native format.

Declaration

[DataMember(Name = "fileTypeDefinitionId", EmitDefaultValue = false)]
public string FileTypeDefinitionId { get; set; }

Property Value

Type	Description
string

Id

Gets or sets the identifier.

Declaration

[JsonProperty(PropertyName = "id", Order = -2147483648)]
public string Id { get; set; }

Property Value

Type	Description
string	The identifier.

IdGenerator

Gets or sets the IdGenerator used for generating sequential IDs./>

Declaration

public IdGenerator IdGenerator { get; set; }

Property Value

Type	Description
IdGenerator	The identifier generator.

OriginalEncoding

Gets or sets the original encoding.

Declaration

[DataMember(Name = "originalEncoding", EmitDefaultValue = false)]
public string OriginalEncoding { get; set; }

Property Value

Type	Description
string	The original encoding.

OriginalFileName

The name of the native file from which this File was constructed.

Declaration

[DataMember(Name = "originalFileName", EmitDefaultValue = false)]
public string OriginalFileName { get; set; }

Property Value

Type	Description
string

ParagraphUnits

A collection of all the ParagraphUnit elements in this File.

Declaration

[DataMember(Name = "paragraphUnits", EmitDefaultValue = false)]
public ParagraphUnitCollection ParagraphUnits { get; set; }

Property Value

Type	Description
ParagraphUnitCollection

Parent

The parent Document of this File.

Declaration

public Document Parent { get; set; }

Property Value

Type	Description
Document

PreferredTargetEncoding

Gets or sets the preferred target encoding.

Declaration

[DataMember(Name = "preferredTargetEncoding", EmitDefaultValue = false)]
public string PreferredTargetEncoding { get; set; }

Property Value

Type	Description
string	The preferred target encoding.

Skeleton

The FileSkeleton holding all the structure element data referenced in this File.

Declaration

[DataMember(Name = "skeleton", EmitDefaultValue = false)]
public FileSkeleton Skeleton { get; set; }

Property Value

Type	Description
FileSkeleton

Methods

Clone()

Clones this instance.

Declaration

public File Clone()

Returns

Type	Description
File	A deep clone of this instance.

Equals(File)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(File other)

Parameters

Type	Name	Description
File	other	An object to compare with this object.

Returns

Type	Description
bool	true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Performs a deep-equals comparison.
System.Object.Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Overrides

MetadataContainer.Equals(object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for this instance.

Overrides

MetadataContainer.GetHashCode()

ShouldSerializeCommentDefinitionIds()

Used by JSON.NET serializer.

Declaration

public bool ShouldSerializeCommentDefinitionIds()

Returns

Type	Description
bool	True if the CommentDefinitionIds property should be serialized.

ShouldSerializeDependencyFiles()

Used by JSON.NET serializer.

Declaration

public bool ShouldSerializeDependencyFiles()

Returns

Type	Description
bool	True if the DependencyFiles property should be serialized.

Implements

IEquatable<T>

ICloneable<T>

IEquatable<T>