Calling all developers! We invite you to provide your input on Feature Experimentation by completing this brief survey.

 

Class ChangeLogUI

A class to register localized description strings for Change Log categories and actions which can then be used in the EPiServer UI

Inheritance
System.Object
ChangeLogUI
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.ChangeLog.UI
Assembly: EPiServer.dll
Version: 7.19.2
Syntax
public static class ChangeLogUI

Methods

GetCategories()

Get all of the registered category descriptions

Declaration
public static IEnumerable<KeyValuePair<int, string>> GetCategories()
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Int32, System.String>>

An System.Collections.Generic.IEnumerable<T>

GetCategoryActions(Int32)

Get all of the registered action descriptions for the category

Declaration
public static IEnumerable<KeyValuePair<int, string>> GetCategoryActions(int category)
Parameters
Type Name Description
System.Int32 category

The category to get the descriptions for

Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Int32, System.String>>

A System.String

GetCategoryActionTranslationKey(Int32, Int32)

Get a translation key registered for a Change Log category action

Declaration
public static string GetCategoryActionTranslationKey(int category, int action)
Parameters
Type Name Description
System.Int32 category

The category to get the translation key for

System.Int32 action

The action to get the translation key for

Returns
Type Description
System.String

A System.String

GetCategoryTranslationKey(Int32)

Get a translation key registered for a Change Log category

Declaration
public static string GetCategoryTranslationKey(int category)
Parameters
Type Name Description
System.Int32 category

The category to get the translation key for

Returns
Type Description
System.String

A System.String

RegisterCategory(Int32, String)

Register a Change Log category with the EPiServer UI

Declaration
public static void RegisterCategory(int category, string translationKey)
Parameters
Type Name Description
System.Int32 category

The category to register

System.String translationKey

The translation key to the EPiServer Language system for the category

RegisterCategoryAction(Int32, Int32, String)

Register a Change Log Action with the EPiServer UI

Declaration
public static void RegisterCategoryAction(int category, int action, string translationKey)
Parameters
Type Name Description
System.Int32 category

The category to register the action for

System.Int32 action

The action to register

System.String translationKey

The translation key to the EPiServer Language system for the action