Click or drag to resize

ILocalesManagerAddCustomLocale Method


Adds a new custom locale or updates an existing custom locale with new values.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax
ICustomLocale AddCustomLocale(
	ILocale baseLocale,
	string regionCode,
	string description
)

Parameters

baseLocale
Type: Ingeniux.CMSILocale
Base standard ISO locale
regionCode
Type: SystemString
Region code/name of the custom locale
description
Type: SystemString
Description of the custom locale

Return Value

Type: ICustomLocale
The created or updated custom locale.
Exceptions
ExceptionCondition
ArgumentExceptionWhen base locale is a custom locale, or when region code is an existing standard ISO locale region code.
Remarks

If the region code already exists in the custom locale's collection, that custom locale will be updated with new information.

the custom locale has to be based on a standard ISO locale. It can never be based on another custom locale.

If the region code provided exists as standard ISO locale region code, the system throws an error.

See Also