IGlobalVariablesCollection Interface |
Represents the Manager object that manages global variables.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
SyntaxThe IGlobalVariablesCollection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity.) |
| Count |
Gets the count of global variables in the collection.
|
| 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 | |
|---|---|---|
 | AddVariable(IGlobalVariable) |
Adds a new global variable to the collection. This overload allows the global variable to be created and sets up all publishing target overrides first.
|
| AddVariable(String, String) |
Adds a new global variable and sets its global value.
|
| PublishGlobalVariables |
Publish global variables for given publishing target. This also applies to the publishing target override value for that publishing target.
|
| RemoveVariable |
Removes a global variable.
|
| 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.) |
| Variable |
Retrieves a global variable by its name. The variable names are unique.
|
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.) |
RemarksLike all manager objects, instances of this manager are retrieved from an IUserSession object. IGlobalVariablesCollection only works within that session object.
C#
using (IUserSession session = store.OpenReadSession(currentUser))
{
IGlobalVariablesCollection globalVariables = session.GlobalVariables;
...
}See Also