TranslationServiceHelper Class

Class containing methods for manipulating with Translation Services (XLIFF format).

Inheritance Hierarchy

System.Object
  CMS.TranslationServices.TranslationServiceHelper

Namespace: CMS.TranslationServices
Assembly: CMS.TranslationServices (in CMS.TranslationServices.dll) Version: 12.0.0

Syntax

public static class TranslationServiceHelper

The TranslationServiceHelper type exposes the following members.

Fields

	Name	Description
Public field Static member	XLIFFEXTENSION	XLIFF file extension
Public field Static member	XLIFFMIME	XLIFF MIME type

Properties

	Name	Description
Public property Static member	AutoImportEnabled	If true, submissions are processed automatically (without explicit approval in administration) when the submission is ready to translate.
Public property Static member	UseCDATAForTranslationUnit	Indicates if CDATA section should be used for translation units.

Methods

	Name	Description
Public method Static member	AnyServiceAvailable	Returns true if at least one service is available (= is enabled and its IsAvailable() method returns true).
Public method Static member	AutoImportSubmission	Processes the submission automatically if enabled. If auto import is disabled, does nothing.
Public method Static member	CancelSubmission	Cancels given submission
Public method Static member	CheckAndDownloadTranslations	Checks all the available translation services for given site and downloads the translations if they are available, stores them in the submission.
Public method Static member	CheckLicense	Checks license limitation.
Public method Static member	CreateSubmissionInfo	Creates new submission to queue (saves it to DB also) and returns the object.
Public method Static member	CreateSubmissionItemInfo	Creates new submission item within given submission (saves it to DB also) and returns the object.
Public method Static member	CreateTargetCultureNode	Returns document of target culture from specified node or creates new culture version as a copy of the original.
Public method Static member	DownloadXLIFF	Starts download of XLIFF document from given submission item.
Public method Static member	DownloadXLIFFinZIP	Starts download of XLIFF document from given submission item.
Public method Static member	GetCultureCode	Gets culture code for the translation process
Public method Static member	GetFormattedStatusString	Returns formatted (colored) status string.
Public method Static member	GetPriorityText	Returns text representation of integer priority.
Public method Static member	GetSubmissionFileName	Gets submission file name with source and target cultures specified.
Public method Static member	GetSubmissionLinkURL	Returns absolute URL of the submission page where a translator can submit translated files.
Public method Static member	GetTranslationsEncoding(Int32)	Returns encoding which should be used for translations (export/import of XLIFF) for given site.
Public method Static member	GetTranslationsEncoding(String)	Returns encoding which should be used for translations (export/import of XLIFF) for given site.
Public method Static member	GetXLIFF(BaseInfo, TranslationSettings, String)	Returns XLIFF export for given object instance.
Public method Static member	GetXLIFF(IDataContainer, TranslationSettings, String)	Returns XLIFF export for given IDataContainer object.
Public method Static member	GetXLIFF(TreeNode, TranslationSettings, String)	Returns XLIFF export for given TreeNode object.
Public method Static member	GetXLIFF(BaseInfo, TranslationSettings, String, Int32, Int32)	Returns XLIFF export for given TreeNode object.
Public method Static member	GetXLIFF(IDataContainer, TranslationSettings, String, Int32, Int32)	Returns XLIFF export for given IDataContainer object.
Public method Static member	GetXLIFF(TreeNode, TranslationSettings, String, Int32, Int32)	Returns XLIFF export for given TreeNode object.
Public method Static member	ImportXLIFFfromZIP	Imports XLIFF documents from ZIP file. Returns list of unrecognized filenames, null if everything went ok.
Public method Static member	IsAuthorizedToTranslateDocument	Checks whether the user is authorized to translate document.
Public method Static member	IsFieldDataTypeAllowedForTranslation	Returns true for Text, LongText, and Binary field types.
Public method Static member	IsServiceAvailable	Returns true if specified service is available (= is enabled and its IsAvailable() method returns true).
Public method Static member	IsTranslationAllowed	Reflects CMSEnableTranslations setting for specified site.
Public method Static member	IsTranslationReady	Returns true if there is at least one translation submission item with target XLIFF for given page and submission is marked as ready.
Public method Static member	LogError	Logs an error message to event log.
Public method Static member	LogEvent	Logs an event if error occurred during action.
Public method Static member	ProcessSubmission	Processes all the translations within the submission. Returns null if everything went ok, otherwise return error message.
Public method Static member	ProcessTranslation(Stream, TranslationSubmissionInfo)	Translates object specified by XLIFF document. Returns translated object if translation went ok, null otherwise.
Public method Static member	ProcessTranslation(String, TranslationSubmissionInfo)	Translates object specified by XLIFF document. Returns translated object if translation went ok, null otherwise.
Public method Static member	ResubmitSubmission	Generates XLIFF documents again and resubmits given submission to the service provider. Returns null if everything went ok, otherwise return error message.
Public method Static member	SubmitToTranslation	Submits the node for translation. If the service is human translation service, creates the whole submission (submission will contain only specified document).
Public method Static member	Translate	Translates given object using machine translation service. Returns true if translation went ok, false if there was any error.
Public method Static member	WriteSubmissionInZIP	Writes the XLIFF documents to translate into a zip file to a given stream.