November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class ChildrenEventArgs

Event arguments passed from IContentLoader.

Inheritance
System.Object
System.EventArgs
ChildrenEventArgs
Inherited Members
System.EventArgs.Empty
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer
Assembly: EPiServer.dll
Version: 9.12.2
Syntax
public class ChildrenEventArgs : EventArgs

Constructors

ChildrenEventArgs(ContentReference, List<IContent>)

Initializes a new instance of the ChildrenEventArgs class.

Declaration
public ChildrenEventArgs(ContentReference contentLink, List<IContent> children)
Parameters
Type Name Description
ContentReference contentLink

The content link.
System.Collections.Generic.List<IContent> children

The children.
Remarks

Will initialize the required access level to AccessLevel.Read.

ChildrenEventArgs(ContentReference, List<IContent>, AccessLevel)

Initializes a new instance of the ChildrenEventArgs class.

Declaration
public ChildrenEventArgs(ContentReference contentLink, List<IContent> children, AccessLevel requiredAccess)
Parameters
Type Name Description
ContentReference contentLink

The content link.
System.Collections.Generic.List<IContent> children

The children.
AccessLevel requiredAccess

The required access.

Properties

CancelAction

Set value to abort the current event handling.

Declaration
public bool CancelAction { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Changing this value may not always change the behavior, see the specific event for details.

CancelReason

Gets or sets the reason for cancel.

Declaration
public string CancelReason { get; set; }
Property Value
Type Description
System.String

The cancel reason.
Remarks

If the cancellation results in an EPiServerCancelAction, this string will be used as the message in the exception.

Children

The children that the event applies to.

Declaration
[Obsolete("Use ChildrenItems instead")]
public PageDataCollection Children { get; set; }
Property Value
Type Description
PageDataCollection
Remarks

Changing this object may not always change the behavior, see the specific event for details.

ChildrenItems

The children that the event applies to.

Declaration
public List<IContent> ChildrenItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<IContent>
Remarks

Changing this object may not always change the behavior, see the specific event for details.

The reference to the contetn item that the event applies to.

Declaration
public ContentReference ContentLink { get; set; }
Property Value
Type Description
ContentReference

Changing this object may not always change the behavior, see the specific event for details.

Creator

This property keeps track of the class/instance that created the page object.

Declaration
public object Creator { get; set; }
Property Value
Type Description
System.Object
Remarks

Note that this property should only be set if you are creating a new PageData instance, not if you are just updating information in an existing object.

Items

Gets a key-value collection that can be used to organize and share data between events handlers during an event chain.

Declaration
public IDictionary Items { get; }
Property Value
Type Description
System.Collections.IDictionary

The page that the event applies to.

Declaration
[Obsolete("Use ContentLink instead")]
public PageReference PageLink { get; set; }
Property Value
Type Description
PageReference

Changing this object may not always change the behavior, see the specific event for details.

RequiredAccess

The required access that the event applies to.

Declaration
public AccessLevel RequiredAccess { get; set; }
Property Value
Type Description
AccessLevel

Extension Methods