Class File
BCM data extracted from a native file.
Inherited Members
Namespace: Sdl.Core.Bcm.BcmModel
Assembly: Sdl.Core.Bcm.BcmModel.dll
Syntax
public class File : MetadataContainer, ICloneable<File>
Constructors
File()
Public constructor.
Declaration
public File()
File(String)
Declaration
public File(string Id)
Parameters
Type | Name | Description |
---|---|---|
System.String | Id |
Properties
CommentDefinitionIds
IDs of CommentDefinition used as file-level comments.
Declaration
public List<int> CommentDefinitionIds { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.Int32> |
DependencyFiles
Dependency files used for converting to and from native format.
Declaration
public List<DependencyFile> DependencyFiles { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<DependencyFile> |
FileTypeDefinitionId
The ID of the filter used for converting the file from native format.
Declaration
public string FileTypeDefinitionId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Id
Gets or sets the identifier.
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
System.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
public string OriginalEncoding { get; set; }
Property Value
Type | Description |
---|---|
System.String | The original encoding. |
OriginalFileName
The name of the native file from which this File was constructed.
Declaration
public string OriginalFileName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ParagraphUnits
A collection of all the ParagraphUnit elements in this File.
Declaration
public ParagraphUnitCollection ParagraphUnits { get; set; }
Property Value
Type | Description |
---|---|
ParagraphUnitCollection |
Parent
Declaration
public Document Parent { get; set; }
Property Value
Type | Description |
---|---|
Document |
PreferredTargetEncoding
Gets or sets the preferred target encoding.
Declaration
public string PreferredTargetEncoding { get; set; }
Property Value
Type | Description |
---|---|
System.String | The preferred target encoding. |
Skeleton
The FileSkeleton holding all the structure element data referenced in this File.
Declaration
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 |
---|---|
System.Boolean | true if the current object is equal to the |
Equals(Object)
Performs a deep-equals comparison.
System.Object.Equals(object)
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
GetHashCode()
Returns a hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
System.Int32 | A hash code for this instance. |
Overrides
ShouldSerializeCommentDefinitionIds()
Used by JSON.NET serializer.
Declaration
public bool ShouldSerializeCommentDefinitionIds()
Returns
Type | Description |
---|---|
System.Boolean | True if the CommentDefinitionIds property should be serialized. |
ShouldSerializeDependencyFiles()
Used by JSON.NET serializer.
Declaration
public bool ShouldSerializeDependencyFiles()
Returns
Type | Description |
---|---|
System.Boolean | True if the DependencyFiles property should be serialized. |