Click or drag to resize

ISettings Interface


Represents the collection of settings of a Ingeniux CMS site instance.

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

The ISettings type exposes the following members.

Properties
 NameDescription
Public propertyApplicationName 
Public propertyArchived Gets/sets the archived value of this entity
(Inherited from IEntity)
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 propertySectionNames 
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 methodGetSetting(String, String, Boolean) Gets a Boolean setting value.
Public methodGetSetting(String, String, Int32) Gets a integer setting value.
Public methodGetSetting(String, String, String) Gets a string setting value.
Public methodGetSetting(String, String, String) Gets a string array setting value.
Public methodCode exampleSerializeForPubTarget Produces a runtime-only settings document for a specific Publishing Target.
Public methodSetSetting(String, String, Boolean) Sets a Boolean setting value.
Public methodSetSetting(String, String, Int32) Sets a integer setting value.
Public methodSetSetting(String, String, String) Sets a string setting value.
Public methodSetSetting(String, String, String) Sets a string array setting value.
Public methodSettingNames 
Public methodTouch Updated the entity's LastModified value to the current time.
(Inherited from IEntity)
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
See Also