Page relationships
List of examples:
Relationship names (types)
Creating a relationship name
// Creates a new relationship name object
RelationshipNameInfo newName = new RelationshipNameInfo();
// Sets the relationship name properties
newName.RelationshipDisplayName = "New relationship";
newName.RelationshipName = "NewRelationship";
// Saves the relationship name to the database
RelationshipNameInfo.Provider.Set(newName);
Updating a relationship name
// Gets the relationship name
RelationshipNameInfo updateName = RelationshipNameInfo.Provider.Get("NewRelationship");
if (updateName != null)
{
// Updates the relationship name properties
updateName.RelationshipDisplayName = updateName.RelationshipDisplayName.ToLower();
// Saves the updated relationship name to the database
RelationshipNameInfo.Provider.Set(updateName);
}
Updating multiple relationship names
// Gets all relationship names whose code name starts with 'New'
var relationshipNames = RelationshipNameInfo.Provider.Get().WhereStartsWith("RelationshipName", "New");
// Loops through individual relationship names
foreach (RelationshipNameInfo name in relationshipNames)
{
// Updates the relationship name properties
name.RelationshipDisplayName = name.RelationshipDisplayName.ToUpper();
// Saves the updated relationship name to the database
RelationshipNameInfo.Provider.Set(name);
}
Assigning a relationship name to a site
// Gets the relationship name
RelationshipNameInfo relationshipName = RelationshipNameInfo.Provider.Get("NewRelationship");
if (relationshipName != null)
{
// Allows the relationship name to be used on the current site
RelationshipNameSiteInfo.Provider.Add(relationshipName.RelationshipNameId, SiteContext.CurrentSiteID);
}
Removing a relationship name from a site
// Gets the relationship name
RelationshipNameInfo relationshipName = RelationshipNameInfo.Provider.Get("NewRelationship");
if (relationshipName != null)
{
// Gets the relationship between the relationship name and the current site
RelationshipNameSiteInfo nameSite =
RelationshipNameSiteInfo.Provider.Get(relationshipName.RelationshipNameId, SiteContext.CurrentSiteID);
// Removes the relationship name from the site
RelationshipNameSiteInfo.Provider.Delete(nameSite);
}
Deleting a relationship name
// Gets the relationship name
RelationshipNameInfo deleteName = RelationshipNameInfo.Provider.Get("NewRelationship");
if (deleteName != null)
{
// Deletes the relationship name
RelationshipNameInfo.Provider.Delete(deleteName);
}
Page relationships
Creating and removing a relationship between pages
// Gets the relationship name
RelationshipNameInfo relationshipName = RelationshipNameInfo.Provider.Get("NewRelationship");
if (relationshipName != null)
{
// Gets the pages that will be connected through the relationship
TreeNode firstPage = new DocumentQuery<TreeNode>()
.Path("/FirstPage", PathTypeEnum.Single)
.OnSite("MySite")
.TopN(1)
.FirstOrDefault();
TreeNode secondPage = new DocumentQuery<TreeNode>()
.Path("/SecondPage", PathTypeEnum.Single)
.OnSite("MySite")
.TopN(1)
.FirstOrDefault();
// Creates the relationship between the pages
RelationshipInfo.Provider.Add(firstPage.NodeID, secondPage.NodeID, relationshipName.RelationshipNameId);
// Removes the relationship between the pages
RelationshipInfo.Provider.Remove(firstPage.NodeID, secondPage.NodeID, relationshipName.RelationshipNameId);
}