AI OnAI Off

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: 8.11.0
Syntax
public static class ChangeLogUI

Methods

GetActionTranslationKey(Activity)

Get a translation key registered for the specified action given by the activity.

Declaration
public static string GetActionTranslationKey(Activity activity)
Parameters
Type Name Description
Activity activity

The activity to get action translation for.
Returns
Type Description
System.String

A System.String

GetActivityActions(String)

Get all of the registered action descriptions for the activity type

Declaration
public static IEnumerable<KeyValuePair<int, string>> GetActivityActions(string activityType)
Parameters
Type Name Description
System.String activityType

The activity type to get actions for
Returns
Type Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Int32, System.String>>

A System.String

GetActivityTypes()

Get all of the registered activity types

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

All registered activity types

GetActivityTypeTranslationKey(Activity)

Get a translation key registered for an activity type-

Declaration
public static string GetActivityTypeTranslationKey(Activity activity)
Parameters
Type Name Description
Activity activity

The activity to get the activity type translation key for
Returns
Type Description
System.String

A System.String

GetCategories()

Get all of the registered category descriptions

Declaration
[Obsolete("Use GetActivityTypes instead")]
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
[Obsolete("Use GetActivityActions instead")]
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
[Obsolete("Use GetActionTranslationKey instead")]
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
[Obsolete("Use GetActivityTypeTranslationKey instead")]
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

RegisterActivityType(String, String)

Register a activity type with the EPiServer UI

Declaration
public static void RegisterActivityType(string activityType, string translationKey)
Parameters
Type Name Description
System.String activityType

The activityType to register
System.String translationKey

The translation key to the EPiServer Language system for the category

RegisterActivityTypeAction(String, Int32, String)

Register a activity action with the EPiServer UI

Declaration
public static void RegisterActivityTypeAction(string activityType, int action, string translationKey)
Parameters
Type Name Description
System.String activityType

The activityType 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

RegisterCategory(Int32, String)

Register a Change Log category with the EPiServer UI

Declaration
[Obsolete("Use RegisterActivityType instead")]
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
[Obsolete("Use RegisterActivityTypeAction instead")]
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