ILocalesManager Interface Ingeniux CMS Content Store API

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: 9.0.565.0 (9.0.565)
Syntax

public interface ILocalesManager : IEntity, 
	IEntityEvents

The ILocalesManager type exposes the following members.

Properties

  NameDescription
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyLastModified
Gets the date when the entity was most recently modified.
(Inherited from IEntity.)
Public propertyLastModifiedUser
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity.)
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertySession
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity.)
Public propertySessionId
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity.)
Top
Methods

  NameDescription
Public methodAddCustomLocale
Adds a new custom locale or updates an existing custom locale with new values.
Public methodAllLocales
Gets all locales, including both standard ISO locales and custom locales.
Public methodCustomLocale
Retrieves a custom locale by its region code.
Public methodCustomLocales
Gets all custom locales.
Public methodCustomLocalesCount
Gets the count of custom locales.
Public methodLocale
Retrieves a locale, which can be either a standard ISO locale or a custom locale.
Public methodLocaleInUse
Checks if the given locale is used by any Pages
Public methodLocalesCount
Gets the count of all locales, including both standard ISO locales and custom locales.
Public methodNativeLocale
Retrieves a standard ISO locale.
Public methodNativeLocales
Gets all standard ISO locales.
Public methodRemoveCustomLocale
Removes a custom locale.
Public methodValidateData
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity.)
Public methodValidateUserPermission
Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
(Inherited from IEntity.)
Top
Events

  NameDescription
Public eventAfterEntitySave
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents.)
Public eventBeforeEntitySave
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents.)
Top
Remarks

Even 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

Reference