Localize the web document viewer

In This Topic

VintaSoft ASP.NET Core Document Viewer Demo provides the localization dictionaries, which allow to localize the web document viewer (WebDocumentViewerJS) into 30 languages (Afrikaans, Arabic, Belarusian, Bulgarian, Chinese, Croatian, Czech, Danish, Dutch, German, Greece, English, Finnish, French, Hebrew, Hindi, Hungarian, Italian, Japanese, Korean, Norwegian, Portugese, Romanian, Russian, Slovakian, Slovenian, Spanish, Swedish, Turkish, Vietnamese).

The localization dictionaries can be found in the "<SdkInstallPath>\VintaSoft\Imaging .NET v12.2\Examples\ASP.NET Core\CSharp\AspNetCoreDocumentViewerDemo\wwwroot\locales\" folder.

If you want to create the custom localization dictionary for the user interface of web document viewer, you need to do the following steps:

Define the list of languages for localization
Create dictionaries for localization
Add JavaScript code for UI localization

If you created the custom localization dictionary for web document viewer and want to share your dictionary with other users, please send us created custom dictionary and we will include dictionary to the source codes of VintaSoft ASP.NET Core Document Viewer Demo.

1. Define the list of languages for localization

First, it is necessary to define the list of languages for localization and create a file of localization settings, for example "settings.json". Here is the content of file "settings.json", which defines that the interface can be localized to English and German languages:

JSON

{
  "locales": [ "en", "af", "ar", "bg", "cs", "da", "de", "el", "es", "fi", "fr", "he", "hi", "hr", "hu", "it", "ja", "ko", "nb", "nl", "pt", "ro", "ru", "sv", "tr", "vi", "zh" ]
}

Next, the "settings.json" file must be added to the content of web application, for example placed in folder "locales".

Finally, it is necessary to add element "link" with information about localization settings onto a web page:

HTML

<link rel="localization" href="/locales/settings.json">

2. Create dictionaries for localization

The dictionary file should have a name, which equals to the browser locale name, and ".txt" extension. For example, the file of English language dictionary must have the name "en.txt", the file of German language dictionary must have the name "de.txt", the file of French language dictionary must have the name "fr.txt", the file of Spanish language dictionary must have the name "es.txt", the file of Italian language dictionary must have the name "it.txt", the file of Portuguese language dictionary must have the name "pt.txt", the file of Russian language dictionary must have the name "ru.txt".

The dictionary file should be located in the same folder with the file "settings.json", in our case this folder is "locales".

For creating English dictionary it is necessary to do the following steps:

Render all elements, which should be localized, on HTML page.
Create an instance of VintasoftLocalizationJS class that allows to localize DOM-elements on HTML page.
Call VintasoftLocalizationJS.getDocumentLocalizationDictionary for getting the English localization dictionary for DOM-elements on HTML page.
Serialize the English localization dictionary using "JSON.stringify" function.
Save serialized JSON object to a file with name "en.txt".

Here is JavaScript code that demonstrates how to create the localization dictionary for a HTML page that contains web document viewer:

JavaScript

...
// create UI localizer
_localizer = new Vintasoft.Shared.VintasoftLocalizationJS();
...

/**
 Creates the dictionary for localization of application UI.
*/
function __createUiLocalizationDictionary() {
    __createDocumentViewerDialogsForLocalization();

    var localizationDict = _localizer.getDocumentLocalizationDictionary();
    var localizationDictString = JSON.stringify(localizationDict, null, '\t');
    console.log(localizationDictString);
}

/**
 Creates the dialogs, which are used in Web Document Viewer, for localization.
*/
function __createDocumentViewerDialogsForLocalization() {
    var floatingContainer = document.getElementById("documentViewerContainer");

    var documentPasswordDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebUiDocumentPasswordDialogJS();
    documentPasswordDialog.render(floatingContainer);

    var imageSelectionDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebImageSelectionDialogJS();
    imageSelectionDialog.render(floatingContainer);

    var printImagesDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebPrintImagesDialogJS();
    printImagesDialog.render(floatingContainer);

    var thumbnailViewerSettingsDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebThumbnailViewerSettingsDialogJS();
    thumbnailViewerSettingsDialog.render(floatingContainer);

    var rotateImageWithAnnotationsDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebRotateImageWithAnnotationsDialogJS();
    rotateImageWithAnnotationsDialog.render(floatingContainer);

    var pdfRedactionMarkAppearanceDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebPdfRedactionMarkAppearanceDialogJS();
    pdfRedactionMarkAppearanceDialog.render(floatingContainer);

    var twainDeviceSelectionDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebTwainDeviceSelectionDialogJS();
    twainDeviceSelectionDialog.render(floatingContainer);

    var twainDeviceCapabilitiesDialog = new Vintasoft.Imaging.DocumentViewer.Dialogs.WebTwainDeviceCapabilitiesDialogJS();
    twainDeviceCapabilitiesDialog.render(floatingContainer);
}

For creating German (or other non English) dictionary it is necessary to do the following steps:

Use English localization dictionary as a template for German localization dictionary, i.e. copy "en.txt" file into "de.txt" file
Translate text values from English language to the German language in "de.txt" file.

Here is an example of simple dictionary file:

JSON

{
        "documentViewer": {
                "fileLabel": {
                        "text": "File"
                },
                "viewLabel": {
                        "text": "View"
                },
                "toolsLabel": {
                        "text": "Tools"
                },
                "annotationsLabel": {
                        "text": "Annotations"
                },
                "uploadFileButton": {
                        "title": "Upload and open file"
                },
                "previousUploadFilesButton": {
                        "title": "Previously Uploaded Files"
                },
                "printImagesButton": {
                        "title": "Print images"
                },
                "downloadFileButton": {
                        "title": "Download image file"
                },
                ...
        }
}

3. Add JavaScript code for UI localization

The VintasoftLocalizationJS class provides functionality for localization of DOM elements and constant strings.

Here is JavaScript code that demonstrates how to enable localization of web document viewer in web application:

JavaScript

/**
 Enables the localization of application UI.
*/
function __enableUiLocalization() {
    // if localizer is ready (localizer loaded localization dictionary)
    if (_localizer.get_IsReady()) {
        // localize DOM-elements of web page
        _localizer.localizeDocument();
    }
    // if localizer is NOT ready
    else
        // wait when localizer will be ready
        Vintasoft.Shared.subscribeToEvent(_localizer, "ready", function () {
            // localize DOM-elements of web page
            _localizer.localizeDocument();
        });

    // subscribe to the "dialogShown" event of document viewer
    Vintasoft.Shared.subscribeToEvent(_docViewer, "dialogShown", function (event, data) {
        _localizer.localizeDocument();
    });
}

Send Feedback