Click or drag to resize

IContentItem Interface


Represents the base of a content item object that has the following properties:

1. Has multiple versions

2. Can be checked out and checked in

3. Contains content including elements and attributes

4. Can be added and advanced in workflow

5. Always created from a Schema

6. Part of a tree structure

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

The IContentItem type exposes the following members.

Properties
  NameDescription
Public propertyCode example_Locale
Gets/sets the locale name of this object, if this object has language property
Public propertyCode exampleAdminRightsEnabled
Gets and sets whether the content item has admin rights enabled. Admin rights will allow actions to the item that cannot normally be done by the user whose session is processing the request.
(Inherited from IContentItemWorkflowSuper.)
Public propertyAssignedGroup
Gets the Group to which this page is currently assigned. If the page is not assigned to a group, this method returns null.
Public propertyAssignedUser
Gets the User to whom this page is currently assigned. If the page is not assigned to a user, this method returns null.
Public propertyAssignmentComment
Gets the comments from assignments when the page was not in workflow.
Public propertyCanMarkForPublish
Controls whether the page is allowed to mark for publish.
Public propertyCanParentRegionRoots
Gets and sets whether this content item allows region roots (content items with a noninherited locale) when the content item isn't language-neutral.
Public propertyCheckedOut
Gets whether this page is checked out. A page has to be checked out to a specific User to be edited. A page's checked-out content is subject to modification by the assigned User. These modifications can only be published if the page is checked in.
Public propertyComments
Gets/sets the comment of this version.

Comments are set during check-in of a IContentItemContent Item

.

However, it can be changed anytime afterwards.

(Inherited from IContentItemVersion.)
Public propertyContentItemType
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 propertyCurrentWorkflow
Gets the workflow this page is in. If page is not in a workflow, this method returns null.
Public propertyDate
Gets the date and time when this version was last changed.
(Inherited from IContentItemVersion.)
Public propertyEndDate
Gets and sets the end date of the page. When set, this page will not be included in navigations when current time is greater than the EndDate value.
Public propertyHierarchy Obsolete.
Public propertyIcon
Gets and sets the icon of the page. The value is the numeric representation of the icon images.
Public propertyCode exampleInWorkflowTransition
Gets and sets whether the content item is being accessed within the bounds of a workflow transition.
(Inherited from IContentItemWorkflowSuper.)
Public propertyJustSynced
Gets whether the page's content was updated via Schema synchronization and hasn't yet been modified directly.
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 propertyLocale
Gets and sets the language of this page.
Public propertyLocaleInherited
Gets whether this page inherits its locale from its ancestor page.
Public propertyManager
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager.)
Public propertyMasterLingualMap
Gets the lingual map between this page and its Master Page.
Public propertyName
Gets and sets the entity's name.
(Inherited from IEntity.)
Public propertyNowSyncing
Gets whether the page is currently being synchronized to the latest version of the Schema used to create it.
Public propertyParentId
Gets the unique ID of the parent object
Public propertyRemoved
Gets whether the page is under Removed status, which means it is currently a descendant of the Recycle Folder.
Public propertySchemaName
Gets the root name of the Schema, which is also the root element name of this version's serialized XML document.
(Inherited from IContentItemVersion.)
Public propertySecurityDescriptor
Gets the security descriptor of this content item
Public propertySecurityInherited
Gets whether this content item has security inherited from its parent
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 propertySiblingPosition
Gets the position of this object among its siblings
Public propertyStartDate
Gets and sets the start date of the page. When set, this page will not be included in navigations when current time is less than the StartDate value.
Public propertyVersionNumber
Gets the version number of this version.
(Inherited from IContentItemVersion.)
Top
Methods
  NameDescription
Public methodAddCategories
Adds Categories association to this Page. Which also means, categorized this page with given categories.
Public methodAddElement
Adds one or multiple elements to the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElementAfter
Adds one or more elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementBefore
Adds one or more elements to the Elements collection before a specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementFirst
Adds one or more elements to the front of the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElements
Adds a group of elements to the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddElementsAfter
Adds a group of elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementsBefore
Adds a group of elements to Elements collection before a specified anchor element.
(Inherited from IContentItemVersion.)
Public methodAddElementsFirst
Adds a group of elements to the front of the Elements collection.
(Inherited from IContentItemVersion.)
Public methodAddToWorkflow
Adds this page to workflow. This operation creates a new workflow instance for this page based on the Workflow Definition provided and assigns the page to the specified User.
Public methodAddToWorkflowDefault
Adds this page to a workflow. If the initial Transition has a Default User specified, the page will be assigned to that user. Otherwise, it will be assigned to the Next Group specified by the transition. This operation creates a new workflow instance for this page based on the Workflow Definition provided.
Public methodAllElements
Retrieves the collection of descendant Elements on which the filter callback method returns true.
(Inherited from IContentItemVersion.)
Public methodAllowUser
Checks whether the given user was granted the specified access level.
Public methodAssignGroup
Assigns this page to a specific User Group.
Public methodAssignUser
Assigns this page to a specific User.
Public methodAssociatedCategories
Retrieves the collection of Categories associated with this page.
Public methodAssociatedCategoriesCount
Gets the count of the Categories that are associated with this page.
Public methodCheckIn
Checks in either the page itself or the page and its descendants.
Public methodCheckInOnProfile
Checks in either the page itself or the page and its descendants toward the Publishing Targets included in the Publishing Profile.
Public methodCheckInSingle(IEnumerableString, String)
Public methodCheckInSingle(IEnumerableIPublishingTarget, String)
Public methodCheckInSingleWithNoValidate
Checks in the page itself without applying validations before check-in.
Public methodCheckInSingleWithNoValidateOnProfile
Checks in the page itself, without applying validations before check-in, toward the Publishing Targets included in the Publishing Profile.
Public methodCheckOut
Checks out the page and assigns it to the current user. A page can only be edited after it is checked out to the current user.
Public methodClaimPageForCurrentUser
Assigns the Page to the current operating User.
Public methodClearElements
Removes all Elements from the collection.
(Inherited from IContentItemVersion.)
Public methodClearSecurity
Clears all access to this page. Note that if no further security setting procedures are taken, no one except administrators will have access to this page . This action permenantly removes the security descriptor for this page.
Public methodCloneLingualMaps
Retrieves the lingual maps between this page and its clone pages.
Public methodCloneLingualMapsCount
Returns the count of all clone lingual maps.
Public methodDecorateElement
Manually apply Session, Manager, and Owner information on an Element field on this version object
(Inherited from IContentItemVersion.)
Public methodCode exampleDescendantIDsWithMaxDepth
Retrieves metadata of the descendants of this page within the given depth limit.
Public methodDescendantIDsWithMaxDepthForPreview
Retrieves the collection of descendants hierarchy information, under the limitations of maximum descendants depth, and maximum descendants count.
Public methodDescendantsCount
Calculates the count of this items descendant items
Public methodDescendantsIDs
Retrieves metadata of the descendants of this page. The results are returned in ascending order based on the pages' hierarchy level.
Public methodElement
Retrieves an Element by its name.
(Inherited from IContentItemVersion.)
Public methodElementById
Retrieves an Element by its unique ID.
(Inherited from IContentItemVersion.)
Public methodElements
Retrieves the direct child Elements of this version.
(Inherited from IContentItemVersion.)
Public methodElements(String)
Retrieves the direct child Elements of this version with names that match the specified name. Case-sensitive.
(Inherited from IContentItemVersion.)
Public methodElementsCount
Gets the count of all direct child Elements.
(Inherited from IContentItemVersion.)
Public methodGetSystemAttribute
Retrieves a system attribute by its enum value. System attributes are attributes on a page document that contain the page's metadata.
Public methodMarkedForPublish
Finds out whether the page is marked for publish on any Publishing Target.
Public methodMarkedForPublishOnTarget(String)
Finds out whether the page is marked for publish on a specific Publishing Target.
Public methodMarkedForPublishOnTarget(IPublishingTarget)
Finds out whether the page is marked for publish on a specific Publishing Target.
Public methodMarkedForPublishPropagated
Finds out whether the page is marked on all Publishing Targets, and the marked versions are the targets are the latest version of this page.
Public methodMarkedVersion(String)
Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
Public methodMarkedVersion(IPublishingTarget)
Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
Public methodMarkedVersionNumber(String)
Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
Public methodMarkedVersionNumber(IPublishingTarget)
Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
Public methodMarkForPublish
Marks this version for publish on the specified Publishing Target
Public methodNextChildPosition
Retrieves position reversed for the next child object to be created under this object
Public methodPath
Retrieves the string path of the page names, starting from the content store root node. Delimited by "/".
Public methodQuickEditableFields
Retrieves the collection of fields, that represents the version object and contains the summary of the version
(Inherited from IContentItemVersion.)
Public methodRemoveCategory
Removes the association between this page and the specified Category.
Public methodRemoveElement
Removes an Element from the descendants collection.
(Inherited from IContentItemVersion.)
Public methodRemoveFromWorkflow
Removes the page from its Current Workflow.
Public methodRemoveSecurityGroup
Removes the access rights of a given user group to this page.
Public methodRollback
Reverts a page's content to that of its latest previous Version.
Public methodSave
Saves this page's XML content. This method must be called to update a page's XML content.
Public methodSecurityGroups
Retrieves the collection of User Groups that have the given access level on this page.
Public methodSecurityGroupsCount
Retrieves the count of User Groups that have a security setting—either explicit or inherited from parent pages—on this page.
Public methodSecurityLevel
Retrieves the access level of specific User. The access level is the highest access level of all the Groups to which this user belongs.
Public methodSendGroupNotificationMail
Sends out a Workflow notification email to all Users of a given Group.
Public methodSendWorkFlowNotificationMail
Sends a workflow notification email to the given recipients.
Public methodSerializeCheckedInVersion
Returns the XML element that was serialized from the checked-in version of this page.
Public methodSetSecurityGroup
Sets the access level to this page for a specific User Group. Successful execution of this method causes the SecurityInherited property to be set to false.
Public methodSetSystemAttribute(EnumSystemAttributes, IAttribute)
Sets value for a system attribute.
Public methodSetSystemAttribute(EnumSystemAttributes, String)
Sets string value for a system attribute.
Public methodUnassign
Removes the assignment of this page so that it doesn't belong to any User or Group.
Public methodUndoCheckOut
Discards the changes in checked-out content and reverts the page to a checked-in state.
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 methodVersionsCount
Gets the count of all previous versions of this page.
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