Document Class

Document Class

Contains the document implementation

Inheritance Hierarchy

SystemObject
Sdl.TranslationStudioAutomation.IntegrationApiDocument

Namespace: Sdl.TranslationStudioAutomation.IntegrationApi
Assembly: Sdl.TranslationStudioAutomation.IntegrationApi (in Sdl.TranslationStudioAutomation.IntegrationApi.dll) Version: 4.2.0.0 (4.1.5799.0)

Syntax

C++

Copy

public sealed class Document

Public NotInheritable Class Document

public ref class Document sealed

[<SealedAttribute>]
type Document =  class end

The Document type exposes the following members.

Properties

	Name	Description
	ActiveFile	Gets the active project file.
	ActiveFileProperties	Gets the active file properties
	ActiveSegmentPair	Gets the active segment pair.
	DisplayFilter	Get the active Display Filter The result will be null if the filter that has been applied on the document is derived from the internal provider. This should permit the developer to differentiate between the internal system filter provider and their own implementation and/or multiple implementations of the interface.
	Files	Get the files of the document
	FilteredSegmentPairs	Get the filtered document segment pairs in a readonly mode
	FilteredSegmentPairsCount	The filtered document segment pairs count
	FocusedDocumentContent	Gets the focus document content
	IsTranslationProviderAvailable	Get a boolean value that indicate if a Translation Provider is available.
	ItemFactory	Gets the factory for the document items
	Mode	Gets the editing mode of the document
	Project	Gets the project of the document
	PropertiesFactory	Gets the factory for the item properties
	SegmentPairs	Get the document segment pairs in a readonly mode
	Selection	Gets the document selection
	TotalSegmentPairsCount	The total document segment pairs count

Top

Methods

	Name	Description
	AddCommentOnSegment(String, String, Severity)	Obsolete. Adds a comment to the target segment
	AddCommentOnSegment(ISegmentPair, String, Severity)	Adds a comment to the target segment
	ApplyFilterOnSegments	Apply filter on the segments from the active document in the editor
	ChangeConfirmationLevelOnSegment(String, ConfirmationLevel)	Obsolete. Sets the segment confirmation level to the specified value
	ChangeConfirmationLevelOnSegment(ISegmentPair, ConfirmationLevel)	Sets the segment confirmation level to the specified value
	ChangeTranslationOriginOnSegment(String, String)	Obsolete. Sets the translation origin for the specified segment to the specified origin type
	ChangeTranslationOriginOnSegment(ISegmentPair, String)	Sets the translation origin for the specified segment to the specified origin type
	DeleteAllCommentsOnSegment(String)	Obsolete. Delete all comments from the target segment.
	DeleteAllCommentsOnSegment(ISegmentPair)	Delete all comments from the target segment.
	DeleteCommentOnSegment(String, IComment)	Obsolete. Delete a specific comment from the target segment.
	DeleteCommentOnSegment(ISegmentPair, IComment)	Delete a specific comment from the target segment.
	GetActiveSegmentPair	Get the active segment pair in a readonly mode.
	GetCommentsFromSegment(String)	Obsolete. Obtain all comments existing from the target segment
	GetCommentsFromSegment(ISegmentPair)	Obtain all comments existing from the target segment
	GetSegmentPairsFromParagraph	Get the segment pairs from a specific paragraph
	ProcessSegmentPair(String, String, ActionISegmentPair, CancelEventArgs)	Obsolete. Processing a single specific segment pair with the ability to alter the source and/or target
	ProcessSegmentPair(ISegmentPair, String, ActionISegmentPair, CancelEventArgs)	Processing a single specific segment pair with the ability to alter the source and/or target
	ProcessSegmentPairs	Processing the document segment pairs with the ability to alter the source and/or target
	SetActiveSegmentPair(String)	Obsolete.
	SetActiveSegmentPair(String, String)	Sets the active segment pair to the segment pair with the given paragraphId and segmentNumber.
	SetActiveSegmentPair(ProjectFile, String)	Sets the active segment pair to the segment pair with the given number.
	TryTranslateActiveSegment	Tries to initiate the translation process for the active segment.
	UpdateCommentOnSegment(String, IComment, String, Severity)	Obsolete. Update a comment text and severity on the target segment
	UpdateCommentOnSegment(ISegmentPair, IComment, String, Severity)	Update a comment text and severity on the target segment
	UpdateParagraphUnitProperties	Directly update the properties of a paragraph unit
	UpdateSegmentPair	Directly update a segment pair in the document
	UpdateSegmentPairProperties(ISegmentPairProperties)	Obsolete. Directly update the properties of a segment pair, without processing the whole segment pair
	UpdateSegmentPairProperties(ISegmentPair, ISegmentPairProperties)	Directly update the properties of a segment pair, without processing the whole segment pair

Top

Events

	Name	Description
	ActiveFileChanged	Triggered when the active file is changed.
	ActiveFilePropertiesChanged	Triggered when the properties of the active file are changed
	ActiveSegmentChanged	Triggered when the active segment is changed.
	ActiveSegmentContentIsReady	The event is triggered when the content for the active segment is ready and it can be modified by a third party application.
	ContentChanged	Triggered when document content is changed.
	DocumentFilterChanged	Triggered when the document filter has changed.
	SegmentsConfirmationLevelChanged	The event is triggered when a ConfirmationLevel is changed for a Segment.
	SegmentsTranslationOriginChanged	The event is triggered when a TranslationOrigin is changed for a Segment.

Top

Reference

Sdl.TranslationStudioAutomation.IntegrationApi Namespace

Community

Edit

Be the first to Edit the community content of this topic.

Comments

Send comments on this topic to https://community.sdl.com/developers/language-developers/