Class RelationDefinition

AllowNavigation

Gets or sets a value indicating whether this relation can be used for navigation to parents or children in the external services (e.g. REST API). This can prevent potentially serious memory intensive operations.

public bool AllowNavigation { get; set; }

AssociatedEntityDefinitionName

Gets or sets name of the IEntityDefinition that is linked to the other end (see Role) of this IRelationDefinition.

public string AssociatedEntityDefinitionName { get; set; }

AssociatedLabels

Gets collection of the culture specific member labels of the associated relation definition.

public IDictionary<CultureInfo, string> AssociatedLabels { get; set; }

Cardinality

Gets or sets cardinality of the relation from the parents point of view.

public RelationCardinality Cardinality { get; set; }

ChildIsMandatory

Gets or sets a value indicating whether relations of this definition must have at least one child.

public bool ChildIsMandatory { get; set; }

CompletionIsCopied

Gets or sets a value indicating whether the child of the relation copies words collection, used for the auto–complete, of the ancestors connected via such marked relations into its collection of words used for the auto-complete functionality in Sitecore Content Hub web portal.

public bool CompletionIsCopied { get; set; }

ContentIsCopied

Gets or sets a value indicating whether if the child of the relation copies full text search content of the ancestors connected via such marked relations into its full text search content.

public bool ContentIsCopied { get; set; }

DefinitionType

Gets type of the member.

public override MemberDefinitionType DefinitionType { get; }

InheritsSecurity

Gets or sets a value indicating whether if this relation is used to inherit any security related meta data (from the parents towards the children).

public bool InheritsSecurity { get; set; }

IsNested

Gets or sets a value indicating whether the relation allows nesting of properties on the associated entity when accessed via the external services (e.g. REST API).

public bool IsNested { get; set; }

IsPathHierarchyRelation

Gets or sets a value indicating whether this relation provides a link between IsPathEnabledDefinition, thus creating a path hierarchy.

public bool IsPathHierarchyRelation { get; set; }

IsPathRelation

Gets or sets a value indicating whether this relation provides a link between a parent entity with IsPathEnabledDefinition or an entity with such an ancestor.

public bool IsPathRelation { get; set; }

IsRenditionRelation

Gets or sets a value indicating whether this relation can be used to retrieve renditions.

public bool IsRenditionRelation { get; set; }

IsTaxonomyHierarchyRelation

Gets or sets a value indicating whether if the relation provides a link between parent and child taxonomy entities of the same entity definition, thus creating a taxonomy hierarchy.

public bool IsTaxonomyHierarchyRelation { get; set; }

IsTaxonomyRelation

Gets or sets a value indicating whether the relation establishes a taxonomy.

public bool IsTaxonomyRelation { get; set; }

NestedPermissions

Gets or sets a value indicating whether permissions are included when nesting this relation in an external service, in similar fashion as with property nesting.

public bool NestedPermissions { get; set; }

NestedProperties

Gets collection of the property names of the associated entity to be used for nesting.

public IList<string> NestedProperties { get; set; }

ParentIsMandatory

Gets or sets a value indicating whether relations of this definition must have at least one parent.

public bool ParentIsMandatory { get; set; }

PathHierarchyScore

Gets or sets score given to the relation which is marked as IsPathHierarchyRelation. If entity has multiple parent hierarchy relations, the paths of entity will be sorted according to this score in ascending way. The first path, if not marked otherwise, will be used as a sole entity path when only one path is required.

public byte PathHierarchyScore { get; set; }

Role

Gets or sets role of the relation on the IEntityDefinition. Parent and child entity definitions share the same conceptual relation definition.

public RelationRole Role { get; set; }

Implements

IRelationDefinition

IMemberDefinition