Click or drag to resize

ISiteBranding Interface
Represents the site branding system, which defines cobranding at the server level. It is used only for XSLT rendering.

Each Site Branding entry corresponding to a presentation style collection. Site Branding at run time is determined by locating its search string on the request URL. If the search string is found on the request URL, site branding is applied.

In other words, site brandings allow for presentation style switching based on request URL, include host name, base URL, and query strings.


Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
Copy
public interface ISiteBranding : IBrandEntryBase, 
	IEntity<ISiteMap>, IEntity, IEntityEvents

The ISiteBranding type exposes the following members.

Properties
 NameDescription
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 propertySearchString Gets and sets the search string of this brand entry.
(Inherited from IBrandEntryBase)
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)
Public propertySiteGroup Gets and sets the group to which this site branding belongs. Optional.
Top
Methods
 NameDescription
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
Remarks

At run time, site branding information is included in the IGX_Info/XPRESS/Site element:

XML
Copy
<IGX_Info>
  <XPRESS>
    <SITE>print</SITE>
  </XPRESS>
</IGX_Info>

User agent brandings are managed by the ISiteMap Manager object.

Example
Site branding is retrieved from ISiteMap:
C#
Copy
ISiteBranding siteBrand = session.SiteMap.Site("print");
See Also