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

AI OnAI Off

Class PageTypeDefault

Default meta data for a page type.

Inheritance
System.Object
PageTypeDefault
Inherited Members
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.DataAbstraction
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
public class PageTypeDefault : IReadOnly<PageTypeDefault>, IReadOnly

Constructors

PageTypeDefault()

Initializes a new instance of the PageTypeDefault class.

Declaration
public PageTypeDefault()

PageTypeDefault(String, TimeSpan, TimeSpan, Boolean, Int32, FilterSortOrder, ContentReference, Int32)

Declaration
public PageTypeDefault(string defaultPageName, TimeSpan startPublishOffset, TimeSpan stopPublishOffset, bool visibleInManu, int peerOrder, FilterSortOrder childOrderRule, ContentReference archiveContentLink, int defaultFrameID)
Parameters
Type Name Description
System.String defaultPageName
System.TimeSpan startPublishOffset
System.TimeSpan stopPublishOffset
System.Boolean visibleInManu
System.Int32 peerOrder
FilterSortOrder childOrderRule
ContentReference archiveContentLink
System.Int32 defaultFrameID

PageTypeDefault(String, TimeSpan, TimeSpan, Boolean, Int32, FilterSortOrder, PageReference, Int32)

Initializes a new instance of the PageTypeDefault class.

Declaration
[Obsolete("Use alternative constructor")]
public PageTypeDefault(string defaultPageName, TimeSpan startPublishOffset, TimeSpan stopPublishOffset, bool visibleInManu, int peerOrder, FilterSortOrder childOrderRule, PageReference archivePageLink, int defaultFrameID)
Parameters
Type Name Description
System.String defaultPageName

The default page name to use for a page type.
System.TimeSpan startPublishOffset

The default offset to add to the current date for a start publish date.
System.TimeSpan stopPublishOffset

The default offset to add to the current date for a stop publish date.
System.Boolean visibleInManu

Determines if pages of the page type should be visible in the menu default.
System.Int32 peerOrder

The default sort index.
FilterSortOrder childOrderRule

The default sort order.
PageReference archivePageLink

The default archive page.
System.Int32 defaultFrameID

The ID of the default frame.

Properties

The default archive content

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

Will return ContentReference.EmptyReference if not defined.

The default archive page

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

Will return PageReference.EmptyReference if not defined.

ChildOrderRule

The default sort order.

Declaration
public FilterSortOrder ChildOrderRule { get; set; }
Property Value
Type Description
FilterSortOrder
Remarks

Will return FilterSortOrder.None if not defined.

DefaultFrame

The default frame.

Declaration
public Frame DefaultFrame { get; set; }
Property Value
Type Description
Frame
Remarks

Will return a Frame object with ID = 0 if not defined.

DefaultPageName

Default page name to use for a page type.

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

Will return null if no name is set.

FrameLoader

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets or sets the frame loader to use.

Declaration
public Func<int, Frame> FrameLoader { get; set; }
Property Value
Type Description
System.Func<System.Int32, Frame>

The frame loader.
Remarks

Should not be changed other than during unit tests. The default implementation uses Load(Int32).

HasValues

Gets a value that indicates if the any values have been set on the PageTypeDefault instance.

Declaration
public bool HasValues { get; }
Property Value
Type Description
System.Boolean

IsReadOnly

Gets a value indicating if current instance is read-only.

Declaration
public virtual bool IsReadOnly { get; protected set; }
Property Value
Type Description
System.Boolean

true if this instance is read-only; otherwise, false.

PeerOrder

The default sort index

Declaration
public int PeerOrder { get; set; }
Property Value
Type Description
System.Int32
Remarks

Will return -1 if not defined.

StartPublishOffset

Default offset to add to current date for a start publish date.

Declaration
public TimeSpan StartPublishOffset { get; set; }
Property Value
Type Description
System.TimeSpan
Remarks

Will return TimeSpan.Zero if no offset is defined.

StopPublishOffset

Default offset to add to current date for a stop publish date.

Declaration
public TimeSpan StopPublishOffset { get; set; }
Property Value
Type Description
System.TimeSpan
Remarks

Will return TimeSpan.Zero if no offset is defined.

VisibleInMenu

If visible in menu should be set by default

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

Will return True by default, since this is the default value given to the VisibleInMenu property on a page.

Methods

CreateWritableClone()

Creates a writable clone of this object.

Declaration
public PageTypeDefault CreateWritableClone()
Returns
Type Description
PageTypeDefault

A clone of this object that is writable.

MakeReadOnly()

Makes the current instance and all it's properties read-only.

Declaration
public virtual void MakeReadOnly()
Remarks

After calling this method the IsReadOnly property will return true.

ThrowIfReadOnly()

Throws an exception if the current instance is read-only.

Declaration
protected virtual void ThrowIfReadOnly()

Explicit Interface Implementations

IReadOnly.CreateWritableClone()

Creates a writable clone of this object.

Declaration
object IReadOnly.CreateWritableClone()
Returns
Type Description
System.Object

A clone of this object that is writable.

Implements

Extension Methods