IPage Methods Ingeniux CMS Content Store API

The IPage type exposes the following members.

Methods

  Name Description
Public method AddAttribute
Adds one or more Attributes to the ContentCollection. This method accepts variable number of Attribute objects as parameters.
(Inherited from IContentCollection.)
Public method AddAttributes
Adds a collection of Attributes to the Content Collection.
(Inherited from IContentCollection.)
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 IPageVersion.)
Public method AddElementAfter
Adds one or more elements to the Elements collection after the specified anchor element.
(Inherited from IPageVersion.)
Public method AddElementBefore
Adds one or more elements to the Elements collection before a specified anchor element.
(Inherited from IPageVersion.)
Public method AddElementFirst
Adds one or more elements to the front of the Elements collection.
(Inherited from IPageVersion.)
Public method AddElements
Adds a group of elements to the Elements collection.
(Inherited from IPageVersion.)
Public method AddElementsAfter
Adds a group of elements to the Elements collection after the specified anchor element.
(Inherited from IPageVersion.)
Public method AddElementsBefore
Adds a group of elements to Elements collection before a specified anchor element.
(Inherited from IPageVersion.)
Public method AddElementsFirst
Adds a group of elements to the front of the Elements collection.
(Inherited from IPageVersion.)
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 IPageVersion.)
Public method AllowUser
Checks whether the given user was granted the specified access level.
Public method Ancestors
Retrieves all of this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy level.
Public method AncestorsCount
Returns the count of ancestors for this page.
Public method AncestorsIDs
Retrieves the metadata of all this page's ancestor pages. The results are returned in ascending order based on the pages' hierarchy 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 Attribute
Gets a specific Attribute by name
(Inherited from IContentCollection.)
Public method Attributes (Inherited from IContentCollection.)
Public method AttributesCount
Gets the count of Attributes in the ContentCollection.
(Inherited from IContentCollection.)
Public method AttributeValue
Gets the value of a specific Attribute by name.
(Inherited from IContentCollection.)
Public method CheckedInPage
Retrieves the checked-in content of this page. If the page is checked out, there could be potential differences between the content of the page and result of this method.
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 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 Children
Retrieves this page's child pages.
Public method ChildrenCount
Returns the count of child pages of this page.
Public method ClaimPageForCurrentUser
Assigns the Page to the current operating User.
Public method ClearAttributes
Clears all Attributes from collection.
(Inherited from IContentCollection.)
Public method ClearElements
Removes all Elements from the collection.
(Inherited from IPageVersion.)
Public method ClearRules
Removes all Page Creation Rules from this page. This action permanently removes the PCR descriptor for this page.
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 ContentUnitsInstantiability
Gets the collection of information on whether a Content Unit can be instantiated, and how many times it can be instantiated.
Public method CreateChildPage
Creates a new child page under the current page.
Public method Descendants
Retrieves the descendants of this page. The results are returned in descending order based on the pages' hierarchy level.
Public method DescendantsCount
Returns the count of all descendants of this page.
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 DescendantsIDsWithMaxDepth
Retrieves metadata of the descendants of this page within the given depth limit.
Public method DescendantsIDsWithMaxDepthForPreview
Public method DescendantsWithMaxDepth
Retrieves the descendants of this page within the given depth limit.
Public method DOM
Retrieves the XML serialization of this page version. This is the same as the Serialize method.
(Inherited from IPageVersion.)
Public method Element
Retrieves an Element by its name.
(Inherited from IPageVersion.)
Public method ElementById
Retrieves an Element by its unique ID.
(Inherited from IPageVersion.)
Public method Elements
Retrieves the direct child Elements of this page version.
(Inherited from IPageVersion.)
Public method Elements(String)
Retrieves the direct child Elements of this page version with names that match the specified name. Case-sensitive.
(Inherited from IPageVersion.)
Public method ElementsCount
Gets the count of all direct child Elements.
(Inherited from IPageVersion.)
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 IsDescendantOf
Checks whether this page is a descendant of another given page.
Public method IsValidRuleTarget
Checks whether, with the given Page Creation Rule, pages can be created as children of this page.
Public method MarkedForPublish
Finds out whether the page is marked for publish on any Publishing Target.
Public method MarkedForPublishOnTarget(String)
Finds out whether the page is marked for publish on a specific Publishing Target.
Public method MarkedForPublishOnTarget(IPublishingTarget)
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 MarkForPublish
Marks this page version for publish on the specified Publishing Target
(Inherited from IPageVersion.)
Public method NextSibling
Retrieves the sibling Page succeeds the given page on the content tree.
Public method PageCreationRules
Retrieves the collection of page creation rules that can be used to create pages under this page. The collection also includes the information on whether the PCR covers descendants.
Public method PageCreationRulesCount
Retrieves the count of the collection of Page Creation Rules that can be used to create pages under this page.
Public method Parent
Retrieves the parent page of the given page.
Public method Path
Retrieves the string path of the page names, starting from the content store root node. Delimited by "/".
Public method PresentationElement
Retrieves an Element that was added by its Presentation Content Unit by its unique ID. This method will not return elements that are outside of the presentation fields group.
(Inherited from IPageVersion.)
Public method PresentationElements
Retrieves the direct child Elements of this page version that were added by its Presentation Content Unit,
(Inherited from IPageVersion.)
Public method PreviousSibling
Retrieves the sibling page that precedes the given page on the content tree.
Public method RegionRoot
Retrieves the Locale (language) root of this page.
Public method RemoveAttribute
Removes an Attribute from the collection.
(Inherited from IContentCollection.)
Public method RemoveCategory
Removes the association between this page and the specified Category.
Public method RemoveChildPage
Removes a child Page of this page.
Public method RemoveChildren
Removes all children of this page. If the page is not in the Recycle Folder, the child pages will be moved there. Otherwise, they are permenantly deleted.
Public method RemoveElement
Removes an Element from the descendants collection.
(Inherited from IPageVersion.)
Public method RemoveFromWorkflow
Removes the page from its Current Workflow.
Public method RemovePageCreationRule
Removes a Page Creation Rule (PCR) from this page.
Public method RemoveSecurityGroup
Removes the access rights of a given user group to this page.
Public method Republish
Publishes the page, with or without its descendants, to the specified Publishing Target.
Public method RevertToVersion
Reverts the page's content to that of a given Version.
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 SetAttributeValue
Sets an Attribute's value. If the Attribute with the given name doesn't exist, this method creates it.
(Inherited from IContentCollection.)
Public method SetPageCreationRule
Sets a page creation rule (PCR) descriptor on this page. When executed successfully, this action sets RulesInherited to false. If this page never had a PCR descriptor before, it will be created automatically. Otherwise, it will resume on the existing descriptor.
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 SiblingIDs
Retrieves sibling page info of this page on the content tree.
Public method Siblings
Retrieves sibling pages of this page on the content tree.
Public method Unassign
Removes the assignment of this page so that it doesn't belong to any User or Group.
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 Version
Retrieves a Version of this page by version number.
Public method VersionId
Retrieves the page version entity ID for the version number, including current if it is so.
Public method Versions
Retrieves the version history of this page. The items are returned by version number in descending order.
Public method VersionsCount
Gets the count of all previous versions of this page.
Top
See Also

Reference