Click or drag to resize

IGlobalVariablesCollection Interface


Represents the Manager object that manages global variables.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IGlobalVariablesCollection : IEntity<ISite>, 
	IEntity, IEntityEvents

The IGlobalVariablesCollection type exposes the following members.

Properties
  NameDescription
Public propertyCount
Gets the count of global variables in the collection.
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 propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
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 methodAddVariable(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.
Public methodAddVariable(String, String)
Adds a new global variable and sets its global value.
Public methodPublishGlobalVariables
Publish global variables for given publishing target. This also applies to the publishing target override value for that publishing target.
Public methodRemoveVariable
Removes a global variable.
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.)
Public methodVariable
Retrieves a global variable by its name. The variable names are unique.
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

Like 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