Kanzi  3.9.4
Localization API
AbstractLocalizationExporter Class Referenceabstract

Abstract Studio plugin command for exporting localization tables. More...

Inheritance diagram for AbstractLocalizationExporter:
[legend]
Collaboration diagram for AbstractLocalizationExporter:
[legend]

Protected Member Functions

abstract void Export (string localizationTableName, IEnumerable< LocalizationTableRow > rows)
 Exports a localization table. More...
 

Static Protected Member Functions

static IEnumerable< string > GetLocales (IEnumerable< LocalizationTableRow > rows)
 Returns the locale strings in the list of localization rows. More...
 

Properties

abstract string Description [get]
 Gets the description of the plugin command. More...
 
virtual string DisplayName [get]
 Gets the display name of the plugin command. More...
 
abstract string Name [get]
 Gets the name of the plugin command. More...
 
KanziStudio Studio [get]
 Gets the KanziStudio object, which provides the entry point for operating with the Kanzi Studio plugin API. More...
 

Detailed Description

Abstract Studio plugin command for exporting localization tables.

Member Function Documentation

◆ Export()

abstract void Export ( string  localizationTableName,
IEnumerable< LocalizationTableRow rows 
)
protectedpure virtual

Exports a localization table.

The table data is listed as localization records.

Parameters
localizationTableNameThe name of the localization table.
rowsA list of localization table rows. It is guaranteed that all rows have the same set of keys. There is one entry for each existing locale.

Implemented in CsvExporter.

◆ GetLocales()

static IEnumerable<string> GetLocales ( IEnumerable< LocalizationTableRow rows)
inlinestaticprotected

Returns the locale strings in the list of localization rows.

Parameters
rowsList of localization table rows.
Returns
Alphabetically sorted enumeration of all locales. If the list of rows is empty, returns an empty list of locales.

Property Documentation

◆ Description

abstract string Description
get

Gets the description of the plugin command.

Command description.

◆ DisplayName

virtual string DisplayName
get

Gets the display name of the plugin command.

Returns Name unless overridden.

Plugin command display name.

◆ Name

abstract string Name
get

Gets the name of the plugin command.

The plugin command names must be unique.

Plugin command name.

◆ Studio

KanziStudio Studio
getprotected

Gets the KanziStudio object, which provides the entry point for operating with the Kanzi Studio plugin API.

KanziStudio object.