IPublishedContent Collections

NOTE: All methods available on IPublishedContent are also available on DynamicPublishedContent. The documentation on this page consists only of the specialized methods available on DynamicPublishedContent, to see all methods available for IPublishedContent, see this documentation.

Collections

All collections returned by Model are of type DynamicPublishedContentList, which itself has a collection of properties.

.[DocumentTypeAlias]s (Pluralised Collections)

Returns the children of the current page, matching the Document type alias

Get all children of type with alias: 'textPage'

@var collection = CurrentPage.TextPages

Get the first child page of type with alias: 'homePage'

@var page = CurrentPage.HomePages.First()

Traversing

.Parent

Returns a dynamic object, referencing the parent of the current page. If current page is at the top of the site tree, null will be returned.

.First()

Returns the first item in a specified collection.

@var NewsArea = CurrentPage.NewsAreas.First();

.Last()

Returns the last item in a specified collection.

@var root =CurrentPage.AncestorsOrSelf.Last();

.Up([int])

Returns a parent item up the tree by one level or by the value specified in the optional parameter. default value = 0, or 1 level. For example to move up two levels set the optional parameter to 1.

@var parent = CurrentPage.Up();
@var parentsParent = CurrentPage.Up(1);

.Down([int])

Returns a child item down the tree by one level or by the value specified in the optional parameter. default value = 0, or 1 level. For example to move down two levels set the optional parameter to 1.

@var firstChild = CurrentPage.Down();
@var firstChildsFirstChild = CurrentPage.Down(1);

.Next([int])

Returns the next sibling item in the tree by one position or by the value specified in the optional parameter. default value = 0, or 1 level. For example to move two positions set the optional parameter to 1.

@var nextSibling = CurrentPage.Next();
@var anotherSibling = CurrentPage.Next(1);

.Previous([int])

Returns the previous sibling item in the tree by one position or by the value specified in the optional parameter. default value = 0, or 1 level. For example to move two positions set the optional parameter to 1.

@var previousSibling = CurrentPage.Previous();
@var anotherSibling = CurrentPage.Previous(1);

.AncestorOrSelf()

The AncestorOrSelf() method has a number of overloads that allow you to quickly traverse the tree and return an item that matches the overloaded criteria. Using the method without any parameters will return the top most node in tree that you are currently navigating.

@var root = CurrentPage.AncestorOrSelf();

Examples

@* get the root item of the current tree *@
@var root = CurrentPage.AncestorOrSelf();

@* get the item at level 2 *@
@var level2Item = CurrentPage.AncestorOrSelf(2);

@* get item with nodeTypeAlias "HomePage" *@
@var home = CurrentPage.AncestorOrSelf("HomePage");

Filtering, Ordering & Extensions

.Where("condition"[, valueIfTrue, valueIfFalse] )

Returns all items matching the given condition. For more details on queries and conditions, see the section below

@var ancestors = CurrentPage.Where("UmbracoNaviHide != @0", "True");

@var HomePage = CurrentPage.Where("NodeTypeAlias == @0 && Level == @1 || Name = @2", "HomePage", 0, "Home").First();

.OrderBy("fieldname [desc][,propertyAlias")

Orders a collection by a field name

@* order by name *@
@var nodes = CurrentPage.Children.OrderBy("Name");

@* order by descending name *@
@var nodes = CurrentPage.Children.OrderBy("Name desc");

.GroupBy("propertyAlias")

Groups items in the collection based on a content property that is used as a key and returns a Collection of Anonymous objects that have two properties. .Key and .Elements that contains a collection of the content items for that grouping.

@{
    var groupedItems = CurrentPage.Children.GroupBy("MyProperty");
    foreach (var group in groupedItems)
    {
        <h2>@group.Key</h2>
        foreach(var item in group.Elements)
        {
            <h3>@el.Name</h3>
        }
    }
}

.InGroupsOf([int])

Returns a collection as a collection of collections. The integer value specifies the size of the groups.

@* return in groups of 3 *@
@foreach(var group in CurrentPage.Children.InGroupsOf(3)){
    <div class="row">
        @foreach(var item in group){
            <div>@item.Name</div>
        }
    </div>
}

.Pluck("PropertyName")

Returns a collection of type new List<string>() of only the specified property and not the entire content item.

@* return only the colour property as a List<string>(); *@
@CurrentPage.Children.Pluck("colour");

.Take(int)

Return only the number of items for a collection specified by the integer value.

@* return the first 3 items from the child collection *@
@var nodes = CurrentPage.Children.Take(3);

.Skip(int)

Return items from the collection after skipping the specified number of items.

@* Skip the first 3 items in the collection and return the rest *@
@var nodes = CurrentPage.Children.Skip(3);

@* using skip and take together you can perform paging operations *@
@var nodes = CurrentPage.Skip(10).Take(10);

.Count()

Returns the number of items in the collection

@int numberOfChildren =  CurrentPage.Children.Count();