Class FileSkeleton

Holds data for a File that is referenced by different MarkupData elements.

Inheritance

System.Object

ExtensionDataContainer

MetadataContainer

FileSkeleton

Implements

System.IEquatable<MetadataContainer>

ICloneable<FileSkeleton>

System.IEquatable<FileSkeleton>

Inherited Members

MetadataContainer.GetMetadata(String)

MetadataContainer.SetMetadata(String, String)

MetadataContainer.Equals(MetadataContainer)

MetadataContainer.ShouldSerialize_metadata()

MetadataContainer.Metadata

ExtensionDataContainer.ExtensionData

Namespace: Sdl.Core.Bcm.BcmModel.Skeleton

Assembly: Sdl.Core.Bcm.BcmModel.dll

Syntax

public class FileSkeleton : MetadataContainer, ICloneable<FileSkeleton>

Examples

A PlaceholderTag element has a DefinitionId that points to an element in the PlaceholderTagDefinitions collection.

Constructors

FileSkeleton()

Public constructor.

Declaration

public FileSkeleton()

Properties

CommentDefinitions

Collection of all the CommentDefinition elements referenced in a File.

Declaration

public SkeletonCollection<CommentDefinition> CommentDefinitions { get; set; }

Property Value

Type	Description
SkeletonCollection<CommentDefinition>

ContextDefinitions

Collection of all the ContextDefinitionelements referenced in a File.

Declaration

public SkeletonCollection<ContextDefinition> ContextDefinitions { get; set; }

Property Value

Type	Description
SkeletonCollection<ContextDefinition>

Contexts

Collection of all the Contextelements referenced in a File.

Declaration

public SkeletonCollection<Context> Contexts { get; set; }

Property Value

Type	Description
SkeletonCollection<Context>

FileId

The File id.

Declaration

public string FileId { get; set; }

Property Value

Type	Description
System.String

FormattingGroups

Collection of all the FormattingGroup elements referenced in a File.

Declaration

public SkeletonCollection<FormattingGroup> FormattingGroups { get; set; }

Property Value

Type	Description
SkeletonCollection<FormattingGroup>

IdGenerator

An IdGenerator instance that creates unique numeric IDs for all the elements in different FileSkeleton collection.

Declaration

public IdGenerator IdGenerator { get; }

Property Value

Type	Description
IdGenerator

ParentFile

The File for which this FileSkeleton is defined.

Declaration

public File ParentFile { get; set; }

Property Value

Type	Description
File

PlaceholderTagDefinitions

Collection of all the PlaceholderTagDefinition elements referenced in a File.

Declaration

public SkeletonCollection<PlaceholderTagDefinition> PlaceholderTagDefinitions { get; set; }

Property Value

Type	Description
SkeletonCollection<PlaceholderTagDefinition>

QuickInsertIds

Collection of all the QuickInsert IDs referenced in a File.

Declaration

public List<string> QuickInsertIds { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

StructureTagDefinitions

Collection of all the StructureTagDefinition elements referenced in a File.

Declaration

public SkeletonCollection<StructureTagDefinition> StructureTagDefinitions { get; set; }

Property Value

Type	Description
SkeletonCollection<StructureTagDefinition>

SubContentPUs

List of all the IDs of ParagraphUnits that are sub-content elements.

Declaration

public List<string> SubContentPUs { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

TagPairDefinitions

Collection of all the TagPairDefinition elements referenced in a File.

Declaration

public SkeletonCollection<TagPairDefinition> TagPairDefinitions { get; set; }

Property Value

Type	Description
SkeletonCollection<TagPairDefinition>

TerminologyData

Collection of all the TerminologyData elements referenced in a File.

Declaration

public SkeletonCollection<TerminologyData> TerminologyData { get; set; }

Property Value

Type	Description
SkeletonCollection<TerminologyData>

Methods

Clone()

Clones this instance.

Declaration

public FileSkeleton Clone()

Returns

Type	Description
FileSkeleton

Equals(FileSkeleton)

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

Declaration

public bool Equals(FileSkeleton other)

Parameters

Type	Name	Description
FileSkeleton	other

Returns

Type	Description
System.Boolean

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

MetadataContainer.Equals(Object)

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

MetadataContainer.GetHashCode()

ShouldSerializeCommentDefinitions()

Used by JSON serialization.

Declaration

public bool ShouldSerializeCommentDefinitions()

Returns

Type	Description
System.Boolean	True if CommentDefinitions should be serialized.

ShouldSerializeContextDefinitions()

Used by JSON serialization.

Declaration

public bool ShouldSerializeContextDefinitions()

Returns

Type	Description
System.Boolean	True if ContextDefinitions should be serialized.

ShouldSerializeContexts()

Used by JSON serialization.

Declaration

public bool ShouldSerializeContexts()

Returns

Type	Description
System.Boolean	True if Contexts should be serialized.

ShouldSerializeFormattingGroups()

Used by JSON serialization.

Declaration

public bool ShouldSerializeFormattingGroups()

Returns

Type	Description
System.Boolean	True if FormattingGroups should be serialized.

ShouldSerializePlaceholderTagDefinitions()

Used by JSON serialization.

Declaration

public bool ShouldSerializePlaceholderTagDefinitions()

Returns

Type	Description
System.Boolean	True if PlaceholderTagDefinitions should be serialized.

ShouldSerializeQuickInsertIds()

Used by JSON serialization.

Declaration

public bool ShouldSerializeQuickInsertIds()

Returns

Type	Description
System.Boolean	True if QuickInsertIds should be serialized.

ShouldSerializeStructureTagDefinitions()

Used by JSON serialization.

Declaration

public bool ShouldSerializeStructureTagDefinitions()

Returns

Type	Description
System.Boolean	True if FormattingGroups should be serialized.

ShouldSerializeSubContentPUs()

Used by JSON serialization.

Declaration

public bool ShouldSerializeSubContentPUs()

Returns

Type	Description
System.Boolean	True if SubContentPUs should be serialized.

ShouldSerializeTagPairDefinitions()

Used by JSON serialization.

Declaration

public bool ShouldSerializeTagPairDefinitions()

Returns

Type	Description
System.Boolean	True if TagPairDefinitions should be serialized.

ShouldSerializeTerminologyData()

Used by JSON serialization.

Declaration

public bool ShouldSerializeTerminologyData()

Returns

Type	Description
System.Boolean	True if TerminologyData should be serialized.

Implements

System.IEquatable<>

ICloneable<T>

System.IEquatable<>