Click or drag to resize

IContentItem Methods


The IContentItem type exposes the following members.

Methods
  Name Description
Public method AddCategories Adds Categories association to this Page. Which also means, categorized this page with given categories.
Public method AddElement Adds one or multiple elements to the Elements collection.
(Inherited from IContentItemVersion)
Public method AddElementAfter Adds one or more elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion)
Public method AddElementBefore Adds one or more elements to the Elements collection before a specified anchor element.
(Inherited from IContentItemVersion)
Public method AddElementFirst Adds one or more elements to the front of the Elements collection.
(Inherited from IContentItemVersion)
Public method AddElements Adds a group of elements to the Elements collection.
(Inherited from IContentItemVersion)
Public method AddElementsAfter Adds a group of elements to the Elements collection after the specified anchor element.
(Inherited from IContentItemVersion)
Public method AddElementsBefore Adds a group of elements to Elements collection before a specified anchor element.
(Inherited from IContentItemVersion)
Public method AddElementsFirst Adds a group of elements to the front of the Elements collection.
(Inherited from IContentItemVersion)
Public method AddToWorkflow 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 method AddToWorkflowDefault 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 method AllElements Retrieves the collection of descendant Elements on which the filter callback method returns true.
(Inherited from IContentItemVersion)
Public method AllowUser Checks whether the given user was granted the specified access level.
Public method AssignGroup Assigns this page to a specific User Group.
Public method AssignUser Assigns this page to a specific User.
Public method AssociatedCategories Retrieves the collection of Categories associated with this page.
Public method AssociatedCategoriesCount Gets the count of the Categories that are associated with this page.
Public method AssociatedCategoryIds  
Public method CanViewCheckedOutContent Returns true if the provided user can view this content items' checked out content
Public method CheckIn Checks in either the page itself or the page and its descendants.
Public method CheckInOnProfile Checks in either the page itself or the page and its descendants toward the Publishing Targets included in the Publishing Profile.
Public method CheckInSingle(IEnumerableIPublishingTarget, String)  
Public method CheckInSingle(IEnumerableString, String)  
Public method CheckInSingleWithNoValidate Checks in the page itself without applying validations before check-in.
Public method CheckInSingleWithNoValidateOnProfile Checks in the page itself, without applying validations before check-in, toward the Publishing Targets included in the Publishing Profile.
Public method CheckOut 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 method ChildrenCount  
Public method ClaimPageForCurrentUser Assigns the Page to the current operating User.
Public method ClearElements Removes all Elements from the collection.
(Inherited from IContentItemVersion)
Public method ClearSecurity 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 method CloneLingualMaps Retrieves the lingual maps between this page and its clone pages.
Public method CloneLingualMapsCount Returns the count of all clone lingual maps.
Public method DecorateElement Manually apply Session, Manager, and Owner information on an Element field on this version object
(Inherited from IContentItemVersion)
Public method Code example DescendantIDsWithMaxDepth Retrieves metadata of the descendants of this page within the given depth limit.
Public method DescendantIDsWithMaxDepthForPreview Retrieves the collection of descendants hierarchy information, under the limitations of maximum descendants depth, and maximum descendants count.
Public method DescendantsCount Calculates the count of this items descendant items
Public method DescendantsIDs Retrieves metadata of the descendants of this page. The results are returned in ascending order based on the pages' hierarchy level.
Public method Element Retrieves an Element by its name.
(Inherited from IContentItemVersion)
Public method ElementById Retrieves an Element by its unique ID.
(Inherited from IContentItemVersion)
Public method Elements Retrieves the direct child Elements of this version.
(Inherited from IContentItemVersion)
Public method Elements(String) Retrieves the direct child Elements of this version with names that match the specified name. Case-sensitive.
(Inherited from IContentItemVersion)
Public method ElementsCount Gets the count of all direct child Elements.
(Inherited from IContentItemVersion)
Public method ForceChangePush Force a push to any change detection on this content item.
Public method GetSystemAttribute Retrieves a system attribute by its enum value. System attributes are attributes on a page document that contain the page's metadata.
Public method MarkedForPublish Finds out whether the page is marked for publish on any Publishing Target.
Public method MarkedForPublishOnTarget(IPublishingTarget) Finds out whether the page is marked for publish on a specific Publishing Target.
Public method MarkedForPublishOnTarget(String) Finds out whether the page is marked for publish on a specific Publishing Target.
Public method MarkedForPublishPropagated 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 method MarkedVersion(IPublishingTarget) Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
Public method MarkedVersion(String) Retrieves the marked version object on a specific Publishing Target. Can be null if not marked on that Publishing Target
Public method MarkedVersionNumber(IPublishingTarget) Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
Public method MarkedVersionNumber(String) Retrieves the marking version number on a specific Publishing Target. If item is not marked on that target, returns -1
Public method MarkForPublish Marks this version for publish on the specified Publishing Target
Public method NewFirstChildPosition Retrieves position for the next child object to be created at the beginning under this object
Public method NextChildPosition Retrieves position reversed for the next child object to be created under this object
Public method Path  
Public method Path(Boolean, String) Retrieves the string path of the page names, starting from the content store root node. Delimited by "/".
Public method QuickEditableFields Retrieves the collection of fields, that represents the version object and contains the summary of the version
(Inherited from IContentItemVersion)
Public method RemoveCategory Removes the association between this page and the specified Category.
Public method RemoveElement Removes an Element from the descendants collection.
(Inherited from IContentItemVersion)
Public method RemoveFromWorkflow Removes the page from its Current Workflow.
Public method RemoveSecurityGroup Removes the access rights of a given user group to this page.
Public method Rollback Reverts a page's content to that of its latest previous Version.
Public method Save Saves this page's XML content. This method must be called to update a page's XML content.
Public method SecurityGroups Retrieves the collection of User Groups that have the given access level on this page.
Public method SecurityGroupsCount Retrieves the count of User Groups that have a security setting—either explicit or inherited from parent pages—on this page.
Public method SecurityLevel 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 method SendGroupNotificationMail Sends out a Workflow notification email to all Users of a given Group.
Public method SendWorkFlowNotificationMail Sends a workflow notification email to the given recipients.
Public method SerializeCheckedInVersion Returns the XML element that was serialized from the checked-in version of this page.
Public method SetSecurityGroup 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 method SetSystemAttribute(EnumSystemAttributes, IAttribute) Sets value for a system attribute.
Public method SetSystemAttribute(EnumSystemAttributes, String) Sets string value for a system attribute.
Public method Touch Updated the entity's LastModified value to the current time.
(Inherited from IEntity)
Public method Unassign Removes the assignment of this page so that it doesn't belong to any User or Group.
Public method Unassociate Removes all taxonomy associations from this Content Item
Public method UndoCheckOut Discards the changes in checked-out content and reverts the page to a checked-in state.
Public method ValidateData Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity)
Public method 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)
Public method VersionsCount Gets the count of all previous versions of this page.
Top
See Also