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

Class PageLanguageSetting

Defined language setting per page in EPiServer, this class is only used for serialization compatibility and has been replaced with ContentLanguageSetting

Inheritance
System.Object
PageLanguageSetting
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: 9.12.2
Syntax
public class PageLanguageSetting

Constructors

PageLanguageSetting()

Initializes a new instance of the PageLanguageSetting class.

Declaration
public PageLanguageSetting()

PageLanguageSetting(PageReference, String)

Initializes a new instance of the PageLanguageSetting class.

Declaration
public PageLanguageSetting(PageReference pageID, string language)
Parameters
Type Name Description
PageReference pageID

ID of the page that this setting will be defined on.

System.String language

The language branch for which this setting will be defined.

PageLanguageSetting(PageReference, String, String, String[])

Initializes a new instance of the PageLanguageSetting class.

Declaration
public PageLanguageSetting(PageReference pageID, string language, string replacementLanguage, string[] languageFallback)
Parameters
Type Name Description
PageReference pageID

ID of the page that this setting will be defined on.

System.String language

The language branch for which this setting will be defined.

System.String replacementLanguage

The default language if a language selection has not been done.

System.String[] languageFallback

A fallback language to use when a language is missing.

PageLanguageSetting(PageReference, String, String, String[], Boolean)

Initializes a new instance of the PageLanguageSetting class.

Declaration
public PageLanguageSetting(PageReference pageID, string language, string replacementLanguage, string[] languageFallback, bool active)
Parameters
Type Name Description
PageReference pageID

ID of the page that this setting will be defined on.

System.String language

The language branch for which this setting will be defined.

System.String replacementLanguage

The default language if a language selection has not been done.

System.String[] languageFallback

A fallback language to use when a language is missing.

System.Boolean active

If the language should be active for editors.

Properties

DefinedOnPage

For the page this setting has been defined on.

Declaration
public PageReference DefinedOnPage { get; set; }
Property Value
Type Description
PageReference

IsActive

Gets or sets a value indicating whether this language is active.

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

LanguageBranch

For the language branch this setting has been defined.

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

LanguageBranchFallback

A list of fallback languages when a language is missing.

Declaration
public string[] LanguageBranchFallback { get; set; }
Property Value
Type Description
System.String[]

ReplacementLanguageBranch

The default language if a language selection has not been done.

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

Methods

Delete()

Deletes settings for the current language branch and page.

Declaration
[Obsolete("Use ContentLanguageSetting instead, this method always throw NotSupportedException")]
public void Delete()

ListTree()

Lists all available settings in the database for all pages.

Declaration
[Obsolete("Use ContentLanguageSetting instead, this method returns an empty list")]
public static IList<PageLanguageSetting[]> ListTree()
Returns
Type Description
System.Collections.Generic.IList<PageLanguageSetting[]>

A list of PageLanguageSettings array, one for each page that has settings defined.

Load(PageReference)

Loads all settings for a particular page.

Declaration
[Obsolete("Use ContentLanguageSetting instead, this method returns an empty list")]
public static PageLanguageSetting[] Load(PageReference pageLink)
Parameters
Type Name Description
PageReference pageLink

The page to load settings for.

Returns
Type Description
PageLanguageSetting[]

Returns array of PageLanguageSettings, empty array if no settings has been defined.

Load(PageReference, String)

Loads settings for a particular page and language.

Declaration
[Obsolete("Use ContentLanguageSetting instead, this method always returns null")]
public static PageLanguageSetting Load(PageReference pageLink, string language)
Parameters
Type Name Description
PageReference pageLink

The page to load settings for.

System.String language

The language branch to load settings for.

Returns
Type Description
PageLanguageSetting

Returns NULL if no settings has been defined.

Save()

Saves changes for the current language branch and page.

Declaration
[Obsolete("Use ContentLanguageSetting instead, this method always throw NotSupportedException")]
public void Save()

Extension Methods