Interface IDocumentItemFactory
Factory for items that can be inserted into the bilingual content model.
Bilingual file type components typically get an instance of this factory
through their implementation of the ItemFactory property, which
is set by the framework during component initialization.
Assembly: Sdl.FileTypeSupport.Framework.Core.dll
Syntax
public interface IDocumentItemFactory
Properties
PropertiesFactory
May hold a reference to the properties factory that is used together
with the document item factory.
Declaration
IPropertiesFactory PropertiesFactory { get; set; }
Property Value
Methods
Creates a new comment associated with a comments collection.
This is somewhat inconsistent with the other factory methods, because there is no
separate comment properties object for wrapping the collection.
Declaration
ICommentMarker CreateCommentMarker(ICommentProperties comments)
Parameters
Returns
CreateDocumentProperties()
Creates an empty document properties instance.
Declaration
IDocumentProperties CreateDocumentProperties()
Returns
CreateFeedback(IRevisionProperties)
Create a feedback marker that can be used to indicate that a part of teh content has user
feedback associated with it.
Declaration
IRevisionMarker CreateFeedback(IRevisionProperties properties)
Parameters
Returns
CreateFileProperties()
Creates an empty file properties instance.
Declaration
IFileProperties CreateFileProperties()
Returns
CreateLocationMarker()
Creates a new location marker that is initialized with a unique LocationMarkerId.
Declaration
ILocationMarker CreateLocationMarker()
Returns
CreateLockedContent(ILockedContentProperties)
Creates a locked content object, which represents locked content.
Declaration
ILockedContent CreateLockedContent(ILockedContentProperties properties)
Parameters
Returns
CreateOtherMarker()
Creates an instance of a generic marker type.
Declaration
IOtherMarker CreateOtherMarker()
Returns
CreateParagraphUnit(LockTypeFlags)
Creates a new localizable ParagraphUnit with empty source and target content.
Declaration
IParagraphUnit CreateParagraphUnit(LockTypeFlags flags)
Parameters
| Type |
Name |
Description |
| LockTypeFlags |
flags |
This indicates which LockTypeFlags are to be used for this ParagraphUnit
|
Returns
CreatePlaceholderTag(IPlaceholderTagProperties)
Creates a placeholder tag instance.
Declaration
IPlaceholderTag CreatePlaceholderTag(IPlaceholderTagProperties tagInfo)
Parameters
Returns
CreateRevision(IRevisionProperties)
Create a revision marker that can be used to indicate that a part of the content was changed
through adding or deleting.
Declaration
IRevisionMarker CreateRevision(IRevisionProperties properties)
Parameters
Returns
CreateRevisionProperties(RevisionType)
Creates a revision properties object, which represents information associated with a revision marker.
Declaration
[Obsolete("Please use IPropertiesFactory.CreateRevisionProperties(RevisionType) instead.")]
IRevisionProperties CreateRevisionProperties(RevisionType type)
Parameters
Returns
CreateSegment(ISegmentPairProperties)
Creates a new segment object and assigns the properties to it.
Declaration
ISegment CreateSegment(ISegmentPairProperties properties)
Parameters
Returns
CreateSegmentPair(ISegment, ISegment)
Creates a segment pair object that can be used as a convenience when working with source and target segments in a IParagraphUnit.
Declaration
ISegmentPair CreateSegmentPair(ISegment source, ISegment target)
Parameters
| Type |
Name |
Description |
| ISegment |
source |
The source segment of a paragraph unit. Must not be null.
|
| ISegment |
target |
The target segment corresponding to the source segment. May be null if no target segment exists in the ParagraphUnit yet.
|
Returns
CreateSegmentPairProperties()
Creates a new segment pair properties object that can be used to create segments.
Declaration
ISegmentPairProperties CreateSegmentPairProperties()
Returns
CreateSerializableContainer()
Creates an empty container for markup data that is guaranteed to be serializable.
Declaration
ISerializableMarkupDataContainer CreateSerializableContainer()
Returns
CreateStructureTag(IStructureTagProperties)
Creates a structure tag instance.
Declaration
IStructureTag CreateStructureTag(IStructureTagProperties tagInfo)
Parameters
Returns
CreateSubSegmentReference(ISubSegmentProperties, ParagraphUnitId)
Creates a sub-segment reference instance.
Declaration
ISubSegmentReference CreateSubSegmentReference(ISubSegmentProperties subSegment, ParagraphUnitId paragraphUnitId)
Parameters
Returns
CreateTagPair(IStartTagProperties, IEndTagProperties)
Creates a tag pair instance.
Declaration
ITagPair CreateTagPair(IStartTagProperties startTagInfo, IEndTagProperties endTagInfo)
Parameters
Returns
CreateText(ITextProperties)
Declaration
IText CreateText(ITextProperties textInfo)
Parameters
Returns
CreateTranslationOrigin()
Creates a new translation origin object that can be assigned to segment pair properties.
Declaration
ITranslationOrigin CreateTranslationOrigin()
Returns
Declaration
ISerializableMarkupDataContainer DeserialzeContainer(IFormatter formatter, Stream serializationStream)
Parameters
| Type |
Name |
Description |
| IFormatter |
formatter |
Formatter to use for de-serialization
|
| Stream |
serializationStream |
Stream that contains the data to de-serialize from
|
Returns