ContentReference Types

Overview

ContentReference is the primary identifier for content items in Optimizely CMS. It wraps an integer ID with optional version and provider information.

Namespace

Optimizely.Cms.Core

ContentReference

Properties

Property	Type	Description
ID	int	The content item ID
WorkID	int	The version number; 0 means published version
ProviderName	string?	Name of the content provider; null for default

Static members

Member	Type	Description
ContentReference.EmptyReference	ContentReference	Represents no content; equivalent to null check
ContentReference.StartPage	ContentReference	The configured start page
ContentReference.RootPage	ContentReference	The root of the content tree
ContentReference.WasteBasket	ContentReference	The trash/recycle bin node
ContentReference.GlobalBlockFolder	ContentReference	Root folder for shared blocks
ContentReference.SiteBlockFolder	ContentReference	Site-specific block folder

Methods

Method	Returns	Description
CreateWritableClone()	ContentReference	Returns a mutable copy
ToReferenceWithoutVersion()	ContentReference	Strips version info, returns the published reference
CompareToIgnoreWorkID(ContentReference)	bool	Compares ignoring version number

PageReference

PageReference inherits from ContentReference. Functionally identical; exists for backward compatibility with page-specific APIs.

Cast	Direction	Notes
PageReference to ContentReference	Implicit	Always safe
ContentReference to PageReference	Explicit	Cast required

ContentArea

A property type representing an ordered collection of content items dropped into a region.

Properties

Property	Type	Description
Items	IList<ContentAreaItem>	Ordered list of items in the area
Count	int	Number of items
IsEmpty	bool	true when the area contains no items
FilteredItems	IEnumerable<ContentAreaItem>	Items filtered by current visitor access and publish state

ContentAreaItem properties

Property	Type	Description
ContentLink	ContentReference	Reference to the content item
ContentGroup	string	Display size/group hint (e.g., “wide”, “narrow”)
AllowedRoles	IList<string>	Roles permitted to view this item

Usage

Working with ContentReference

C# (.NET)

csharp Copy

// Check for empty reference
if (ContentReference.IsNullOrEmpty(page.RelatedArticle))
  return;

// Compare ignoring version
bool isSamePage = refA.CompareToIgnoreWorkID(refB);

// Get the published version reference
var publishedRef = contentRef.ToReferenceWithoutVersion();

// Use well-known references
var startPage = _loader.Get<StartPage>(ContentReference.StartPage);
var trashItems = _loader.GetChildren<IContent>(ContentReference.WasteBasket);

Iterating a ContentArea

C# (.NET)

csharp Copy

// Render items from a ContentArea property
if (!page.MainContent.IsEmpty)
{
  foreach (var item in page.MainContent.FilteredItems)
  {
      var block = _loader.Get<IContent>(item.ContentLink);
      // render block...
  }
}

Related

• IContent Interface — ContentLink and ParentLink properties
• Property Types Reference — All CMS property types
• IContentLoader Interface — Loading content by reference