ICategoryNode Interface

Ingeniux CMS Content Store API

Represents one CategoryNode in the Taxonomy tree.

Categories are used to tag Page objects, creating another way to organize and index Page objects.

The Taxonomy system is hierarchical. Each CategoryNode may have parent and children nodes.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public interface ICategoryNode : IEntity, 
	IEntityEvents, ICategoryEvents

Public Interface ICategoryNode
	Inherits IEntity, IEntityEvents, ICategoryEvents

public interface class ICategoryNode : IEntity, 
	IEntityEvents, ICategoryEvents

type ICategoryNode =  
    interface
        interface IEntity
        interface IEntityEvents
        interface ICategoryEvents
    end

The ICategoryNode type exposes the following members.

Properties

	Name	Description
	Created	Gets the entity's creation date. (Inherited from IEntity.)
	CreationLocale	Gets the locale under which this category node was created.
	CreationUser	Gets the ID of the User who created this entity. (Inherited from IEntity.)
	CurrentLocale	Gets the current operating locale.
	Description	Gets and sets the description of this CategoryNode.
	ExternalID	Gets and sets the ExternalID of this CategoryNode.
	Hierarchy	Gets the hierarchy value of this CategoryNode.
	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.)
	Name	Gets and sets the entity's name. (Inherited from IEntity.)
	OriginalDescription	Gets the description of this CategoryNode in its native creation locale.
	OriginalName	Gets the name of this CategoryNode in its native creation locale.
	OriginalTypeName	Gets the type name of this CategoryNode in its native creation locale.
	PermissionInherited
	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.)
	Translated	Checks if this CategoryNode has translation under CurrentLocale
	TypeName	Gets and sets the name of the category type under the current locale.

Top

Methods

	Name	Description
	AddPage	Associates a new page with this CategoryNode.
	AddPages	Associates a collection of new pages with this CategoryNode.
	AddPermission	Adds a new permission to this CategoryNode.
	AddPermissions	Adds a collection of new permissions to this CategoryNode.
	AddSynonym	Adds a new synonym under a given locale.
	AllowAccess	Check if a given IUser is allowed the type of access specified.
	Ancestors
	AncestorsCount	Gets the ancestor count for this CategoryNode.
	Children	Gets the child nodes of this CategoryNode in a paginated format.
	ChildrenCount	Gets the count of child nodes of this CategoryNode.
	Depth	Gets the hierarchy depth of this CategoryNode, starting from the root CategoryNode.
	Descendants	Gets descendants of this CategoryNode, in a paginzated format.
	DescendantsCount	Gets the count of all descendants of this CategoryNode.
	HasPage	Checks whether a given page is associated with this CategoryNode.
	Pages	Gets all pages associated with this CategoryNode.
	PagesCount	Gets the count of all pages associated with this CategoryNode, with or without its descendants.
	Parent	Gets the parent CategoryNode of this node.
	Path	Gets the path of this CategoryNode.
	Permissions	Gets the permissions of this CategoryNode.
	PermissionsCount	Gets the count of permissions defined for this CategoryNode.
	Remove	Permanently removes this CategoryNode from the Taxonomy tree.
	RemoveChildren	Permanently removes all descendants of this CategoryNode from the Taxonomy tree.
	RemovePage	Removes association of this CategoryNode from a given page.
	RemovePages	Removes all page associations from this CategoryNode.
	RemovePermission	Remove a UserGroup's permission entries from this CategoryNode.
	RemoveSynonym	Removes a synonym from this CategoryNode.
	RemoveSynonyms	Removes all synonyms from this CategoryNode under given locale or across all locales
	RemoveTranslation	Removes a translation from this CategoryNode.
	RemoveTranslations	Removes all translations from this CategoryNode.
	ResetPermissions	Resets permissions for this CategoryNode.
	SetTranslation	Sets translation for this CategoryNode under a specific locale.
	Synonyms	Gets the synonyms of this CategoryNode across all locales.
	Synonyms(ILocale)	Gets the synonyms of this CategoryNode defined under a given locale.
	SynonymsCount	Gets the count of synonyms, under given locale or across all locales.
	Translations	Gets all translations of this CategoryNode across all locales.
	TranslationsCount	Gets the count of translations for this CategoryNode.
	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.)

Top

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.)
	CategoryRenamed	This event is fired when a category is renamed. (Inherited from ICategoryEvents.)

Top

Remarks

CategoryNode instances are retrieved from TaxonomyManager:

Copy

ICategoryNode category = session.TaxonomyManager.Category("Categories/342");

Examples

Example of XML serialization for a CategoryNode "Animalia"

Copy

<C ID="198" N="Animalia" D="Animals Category" EID="G2374D-T948975" T="Kingdom" locale="en-us" LUU="ingeniux\awang" LUD="20130815T16:24:08" />

Reference

Ingeniux.CMS Namespace

ITaxonomyManagerCategory(String)

Ingeniux.CMSIHierarchyId

Ingeniux.CMSINodeLevelPermission

Ingeniux.CMSICategorySynonym

Ingeniux.CMSICategoryTranslation

Ingeniux.CMSILocale

Ingeniux.CMSIPage