ILocalesManager Interface |
Represents the entity that holds the collection of custom locales. Also provides the
the functionality to list or retrieve standard ISO locales.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe ILocalesManager type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| Created |
Gets the entity's creation date.
(Inherited from IEntity.) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity.) |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity.) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.) |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.) |
Methods| Name | Description | |
|---|---|---|
 | AddCustomLocale |
Adds a new custom locale or updates an existing custom locale with new values.
|
| AllLocales |
Gets all locales, including both standard ISO locales and custom locales.
|
| CustomLocale |
Retrieves a custom locale by its region code.
|
| CustomLocales |
Gets all custom locales.
|
| CustomLocalesCount |
Gets the count of custom locales.
|
| Locale |
Retrieves a locale, which can be either a standard ISO locale or a custom locale.
|
| LocaleInUse |
Checks if the given locale is used by any Pages
|
| LocalesCount |
Gets the count of all locales, including both standard ISO locales and custom locales.
|
| NativeLocale |
Retrieves a standard ISO locale.
|
| NativeLocales |
Gets all standard ISO locales.
|
| RemoveCustomLocale |
Removes a custom locale.
|
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity.) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity.) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.) |
RemarksEven though it is called a manager, it is an actual entity that stores in the content store and also works like a utility class.
See Also