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

public interface ICategoryNode : IEntity, 
	IEntityEvents, ICategoryEvents

The ICategoryNode type exposes the following members.

Properties

  NameDescription
Public propertyCreated
Gets the entity's creation date.
(Inherited from IEntity.)
Public propertyCreationLocale
Gets the locale under which this category node was created.
Public propertyCreationUser
Gets the ID of the User who created this entity.
(Inherited from IEntity.)
Public propertyCurrentLocale
Gets the current operating locale.
Public propertyDescription
Gets and sets the description of this CategoryNode.
Public propertyExternalID
Gets and sets the ExternalID of this CategoryNode.
Public propertyHierarchy
Gets the hierarchy value of this CategoryNode.
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 propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyOriginalDescription
Gets the description of this CategoryNode in its native creation locale.
Public propertyOriginalName
Gets the name of this CategoryNode in its native creation locale.
Public propertyOriginalTypeName
Gets the type name of this CategoryNode in its native creation locale.
Public propertyPermissionInherited
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 propertyTranslated
Checks if this CategoryNode has translation under CurrentLocale
Public propertyCode exampleTypeName
Gets and sets the name of the category type under the current locale.
Top
Methods

  NameDescription
Public methodAddPage
Associates a new page with this CategoryNode.
Public methodAddPages
Associates a collection of new pages with this CategoryNode.
Public methodAddPermission
Adds a new permission to this CategoryNode.
Public methodAddPermissions
Adds a collection of new permissions to this CategoryNode.
Public methodAddSynonym
Adds a new synonym under a given locale.
Public methodAllowAccess
Check if a given IUser is allowed the type of access specified.
Public methodAncestors
Public methodAncestorsCount
Gets the ancestor count for this CategoryNode.
Public methodChildren
Gets the child nodes of this CategoryNode in a paginated format.
Public methodChildrenCount
Gets the count of child nodes of this CategoryNode.
Public methodDepth
Gets the hierarchy depth of this CategoryNode, starting from the root CategoryNode.
Public methodDescendants
Gets descendants of this CategoryNode, in a paginzated format.
Public methodDescendantsCount
Gets the count of all descendants of this CategoryNode.
Public methodHasPage
Checks whether a given page is associated with this CategoryNode.
Public methodPages
Gets all pages associated with this CategoryNode.
Public methodPagesCount
Gets the count of all pages associated with this CategoryNode, with or without its descendants.
Public methodParent
Gets the parent CategoryNode of this node.
Public methodCode examplePath
Gets the path of this CategoryNode.
Public methodPermissions
Gets the permissions of this CategoryNode.
Public methodPermissionsCount
Gets the count of permissions defined for this CategoryNode.
Public methodRemove
Permanently removes this CategoryNode from the Taxonomy tree.
Public methodRemoveChildren
Permanently removes all descendants of this CategoryNode from the Taxonomy tree.
Public methodRemovePage
Removes association of this CategoryNode from a given page.
Public methodRemovePages
Removes all page associations from this CategoryNode.
Public methodRemovePermission
Remove a UserGroup's permission entries from this CategoryNode.
Public methodRemoveSynonym
Removes a synonym from this CategoryNode.
Public methodRemoveSynonyms
Removes all synonyms from this CategoryNode under given locale or across all locales
Public methodRemoveTranslation
Removes a translation from this CategoryNode.
Public methodRemoveTranslations
Removes all translations from this CategoryNode.
Public methodResetPermissions
Resets permissions for this CategoryNode.
Public methodSetTranslation
Sets translation for this CategoryNode under a specific locale.
Public methodSynonyms
Gets the synonyms of this CategoryNode across all locales.
Public methodSynonyms(ILocale)
Gets the synonyms of this CategoryNode defined under a given locale.
Public methodSynonymsCount
Gets the count of synonyms, under given locale or across all locales.
Public methodTranslations
Gets all translations of this CategoryNode across all locales.
Public methodTranslationsCount
Gets the count of translations for this CategoryNode.
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.)
Public eventCategoryRenamed
This event is fired when a category is renamed.
(Inherited from ICategoryEvents.)
Top
Remarks

CategoryNode instances are retrieved from TaxonomyManager:

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

Example of XML serialization for a CategoryNode "Animalia"
<C ID="198" N="Animalia" D="Animals Category" EID="G2374D-T948975" T="Kingdom" locale="en-us" LUU="ingeniux\awang" LUD="20130815T16:24:08" />
See Also

Reference