Interface IPropertiesFactory

Interface implemented by factories for property objects.

All file type components should use this interface to create properties objects (unless they are created by calling Clone().

Namespace: Sdl.FileTypeSupport.Framework.NativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface IPropertiesFactory

Properties

FormattingItemFactory

The factory used to instantiate formatting items name/value pairs

Declaration

IFormattingItemFactory FormattingItemFactory { get; set; }

Property Value

Type	Description
IFormattingItemFactory

Methods

CreateComment(string, string, Severity)

Creates a new comment with the specified properties.

Declaration

IComment CreateComment(string text, string author, Severity severity)

Parameters

Type	Name	Description
string	text	Textual content of the comment
string	author	Name of user or system that created the comment
Severity	severity	Severity level of the comment

Returns

Type	Description
IComment	A new comment that can be added to a ICommentProperties collection. The date of the comment has been set to Now.

CreateCommentProperties()

Creates a properties object for storing comments.

Declaration

ICommentProperties CreateCommentProperties()

Returns

Type	Description
ICommentProperties

CreateContextInfo(string)

Creates a single piece of context information.

Declaration

IContextInfo CreateContextInfo(string contextType)

Parameters

Type	Name	Description
string	contextType	The type of the context to create.

Returns

Type	Description
IContextInfo

Remarks

If the context type is one of the values defined in Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.StandardContextTypes or Sdl.FileTypeSupport.Framework.Core.Utilities.NativeApi.TMMatchContextTypes, then the returned context will have the properties set to the default preferred values for that context type. If a different value is used, the returned context will have empty values for all other context properties.

CreateContextProperties()

Creates properties that can hold prioritized context information.

Declaration

IContextProperties CreateContextProperties()

Returns

Type	Description
IContextProperties

CreateCustomInfoProperties()

Creates properties used to communicate temporary information to other file type components.

Declaration

ICustomInfoProperties CreateCustomInfoProperties()

Returns

Type	Description
ICustomInfoProperties

CreateDependencyFileProperties(string)

Create a properties representing a dependency file.

Declaration

IDependencyFileProperties CreateDependencyFileProperties(string currentFilePath)

Parameters

Type	Name	Description
string	currentFilePath	The full path to the current location of the dependency file.

Returns

Type	Description
IDependencyFileProperties	A dependency file properties object initialized with the current file path and default values for all other properties.

CreateEndTagProperties(string)

Creates properties for an end tag (that matches a previously emitted start tag).

Declaration

IEndTagProperties CreateEndTagProperties(string tagContent)

Parameters

Type	Name	Description
string	tagContent

Returns

Type	Description
IEndTagProperties

CreateFeedbackProperties(RevisionType)

Creates a feedback properties object, which represents information associated with user feedback.

Declaration

IRevisionProperties CreateFeedbackProperties(RevisionType type)

Parameters

Type	Name	Description
RevisionType	type

Returns

Type	Description
IRevisionProperties

CreateLockedContentProperties(LockTypeFlags)

Creates properties that indicates the lock type.

Declaration

ILockedContentProperties CreateLockedContentProperties(LockTypeFlags lockType)

Parameters

Type	Name	Description
LockTypeFlags	lockType

Returns

Type	Description
ILockedContentProperties

CreatePlaceholderTagProperties(string)

Creates properties for a standalone inline tag.

Declaration

IPlaceholderTagProperties CreatePlaceholderTagProperties(string tagContent)

Parameters

Type	Name	Description
string	tagContent	Tag content including delimiters

Returns

Type	Description
IPlaceholderTagProperties

CreateRevisionProperties(RevisionType)

Creates a revision properties object, which represents information associated with a revision marker.

Declaration

IRevisionProperties CreateRevisionProperties(RevisionType type)

Parameters

Type	Name	Description
RevisionType	type

Returns

Type	Description
IRevisionProperties

CreateStartTagProperties(string)

Creates properties for a start tag that may appear inside localizable content, and that has a corresponding end tag.

Declaration

IStartTagProperties CreateStartTagProperties(string tagContent)

Parameters

Type	Name	Description
string	tagContent	Tag content including delimiters

Returns

Type	Description
IStartTagProperties

CreateStructureInfo()

Creates an empty document structure object that can be used to help define the outline of the document.

Declaration

IStructureInfo CreateStructureInfo()

Returns

Type	Description
IStructureInfo

CreateStructureInfo(IContextInfo, bool, IStructureInfo)

Creates a document structure object that can be used to help define the outline of the document

Declaration

IStructureInfo CreateStructureInfo(IContextInfo contextInfo, bool mustUseDisplayName, IStructureInfo parentStructure)

Parameters

Type	Name	Description
IContextInfo	contextInfo	The context info in the document to which the structural info relates.
bool	mustUseDisplayName	True if the client should always show the DisplayName property. False if the client should attempt to display the matching text in the document. Note: setting this parameter to true also makes sure that the structure will appear in the tree; setting this parameter to false allows the client to decide whether it should be displayed.
IStructureInfo	parentStructure	The parent structure in the structural tree (can be null if it has no parent)

Returns

Type	Description
IStructureInfo

CreateStructureTagProperties(string)

Creates properties for a tag representing structural information.

Declaration

IStructureTagProperties CreateStructureTagProperties(string tagContent)

Parameters

Type	Name	Description
string	tagContent	Tag content including delimiters

Returns

Type	Description
IStructureTagProperties

CreateSubSegmentProperties(int, int)

Create properties used to indicate where localizable content appears inside a tag.

Declaration

ISubSegmentProperties CreateSubSegmentProperties(int offset, int length)

Parameters

Type	Name	Description
int	offset
int	length

Returns

Type	Description
ISubSegmentProperties

CreateTextProperties(string)

Creates properties for localizable text.

Declaration

ITextProperties CreateTextProperties(string text)

Parameters

Type	Name	Description
string	text

Returns

Type	Description
ITextProperties