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