Class ClassHelper

Namespace

CMS.Base

Assembly

CMS.Base.dll

Helper to provide general access to assemblies and classes.

[Obsolete("Class was not intended for public use and will be removed.")]
[ObsoleteSince(29, 3)]
public class ClassHelper : AbstractHelper<ClassHelper>

Inheritance

object

CoreMethods

AbstractHelper

AbstractHelper<ClassHelper>

ClassHelper

Inherited Members

AbstractHelper<ClassHelper>.HelperObject

AbstractHelper<ClassHelper>.SetAsDefaultHelper()

CoreMethods.GetString(string, string)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Fields

ASSEMBLY_APPCODE

AppCode constant.

public const string ASSEMBLY_APPCODE = "App_Code"

Field Value

string

OnGetCustomClass

Fires when the custom class is required.

public static EventHandler<ClassEventArgs> OnGetCustomClass

Field Value

EventHandler<ClassEventArgs>

Properties

DefaultAssembly

Gets or sets default assembly for loading classes. Default assembly is used when the assembly given by a parameter is not found.

public static Assembly DefaultAssembly { get; set; }

Property Value

Assembly

Methods

ClassLoaded(string, string)

Indicates if given class is loaded.

public static bool ClassLoaded(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

bool

ClassLoadedInternal(string, string)

Indicates if given class is loaded.

protected virtual bool ClassLoadedInternal(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

bool

GetAliasesFor(string)

Returns class aliases registerd for the given className.

public static IEnumerable<string> GetAliasesFor(string className)

Parameters

className string

Full class name.

Returns

IEnumerable<string>

GetAliasesForInternal(string)

Returns class aliases registerd for the given className.

protected virtual IEnumerable<string> GetAliasesForInternal(string className)

Parameters

className string

Full class name.

Returns

IEnumerable<string>

GetAssembly(string)

Loads the given assembly.

public static Assembly GetAssembly(string assemblyName)

Parameters

assemblyName string

Assembly name

Returns

Assembly

GetAssemblyInternal(string)

Loads the given assembly.

protected virtual Assembly GetAssemblyInternal(string assemblyName)

Parameters

assemblyName string

Assembly name

Returns

Assembly

GetAssemblyNames(string, ClassTypeSettings)

Gets list of assembly names by given restrictions.

public static List<string> GetAssemblyNames(string assembliesFilter, ClassTypeSettings settings = null)

Parameters

assembliesFilter string

File system filter for list assemblies

settings ClassTypeSettings

Settings used for filter list of classes

Returns

List<string>

GetAssemblyNamesInternal(string, ClassTypeSettings)

Gets list of assembly names by given restrictions. Returns assemblies that contains at least one class fulfilling restrictions.

protected virtual List<string> GetAssemblyNamesInternal(string assembliesFilter, ClassTypeSettings settings)

Parameters

assembliesFilter string

String to filter list of assembly names

settings ClassTypeSettings

Settings used for filter classes

Returns

List<string>

GetBaseTypes(Type)

Return all base types of given type.

public static IEnumerable<Type> GetBaseTypes(Type type)

Parameters

type Type

Returns

IEnumerable<Type>

Exceptions

ArgumentNullException

When type has null value.

GetClass(string, string)

Gets the new object of given class.

public static object GetClass(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

object

GetClassInternal(string, string)

Gets the new object of given class.

protected virtual object GetClassInternal(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

object

GetClassType(string, string)

Gets the new object of given class.

public static Type GetClassType(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

Type

GetClassTypeInternal(string, string)

Gets the type of given class.

protected virtual Type GetClassTypeInternal(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

Type

GetClass<ReturnType>(string, string)

Gets the new object of given class.

public static ReturnType GetClass<ReturnType>(string assemblyName, string className)

Parameters

assemblyName string

Assembly name

className string

Full class name

Returns

ReturnType

Type Parameters

ReturnType

Return class type

GetClasses(string, ClassTypeSettings)

Gets classes for given assembly name and filter settings

public static List<string> GetClasses(string assemblyName, ClassTypeSettings settings)

Parameters

assemblyName string

Assembly name

settings ClassTypeSettings

Settings used for filter list of classes

Returns

List<string>

GetClassesInternal(string, ClassTypeSettings)

Gets classes for given assembly name and class restrictions settings.

protected virtual List<string> GetClassesInternal(string assemblyName, ClassTypeSettings settings)

Parameters

assemblyName string

Assembly name

settings ClassTypeSettings

Settings used for filter list of classes

Returns

List<string>

GetCustomClass(string, string, ref object)

Attempts to get the custom class

protected virtual bool GetCustomClass(string assemblyName, string className, ref object obj)

Parameters

assemblyName string

Assembly name

className string

Class name

obj object

Returns the class object

Returns

bool

GetCustomClassNames()

Gets the list of registered custom class names.

public static List<string> GetCustomClassNames()

Returns

List<string>

GetCustomClassNamesInternal()

Gets the list of registered custom class names.

protected virtual List<string> GetCustomClassNamesInternal()

Returns

List<string>

GetEmptyObject(Type)

Gets the empty object of the given type

public static object GetEmptyObject(Type objectType)

Parameters

objectType Type

Object type

Returns

object

IsAllowed(Type, ClassTypeSettings)

Checks if given type is allowed based on base class name.

public static bool IsAllowed(Type type, ClassTypeSettings settings)

Parameters

type Type

Type of class

settings ClassTypeSettings

Settings used for filter list of classes

Returns

bool

IsCustomClass(string)

Indicates if given assembly name represents custom class

public static bool IsCustomClass(string assemblyName)

Parameters

assemblyName string

Assembly name

Returns

bool

RegisterAliasFor<ObjectType>(string, string)

Registers the class alias for backward compatibility

public static void RegisterAliasFor<ObjectType>(string assemblyName, string className) where ObjectType : new()

Parameters

assemblyName string

Assembly name

className string

Class name

Type Parameters

ObjectType

RegisterCustomClass(string, string, IObjectFactory)

Registers the custom class under the given assembly name and class name. Overrides the default one

public static void RegisterCustomClass(string assemblyName, string className, IObjectFactory factory)

Parameters

assemblyName string

Assembly name

className string

Class name

factory IObjectFactory

Object factory to provide the class

RegisterCustomClass<ClassType>(string)

Registers the custom App_Code class under the class name. Overrides the default one

public static void RegisterCustomClass<ClassType>(string className) where ClassType : class, new()

Parameters

className string

Class name

Type Parameters

ClassType

RegisterCustomClass<ClassType>(string, string)

Registers the custom class under the given assembly name and class name. Overrides the default one

public static void RegisterCustomClass<ClassType>(string assemblyName, string className) where ClassType : new()

Parameters

assemblyName string

Assembly name

className string

Class name

Type Parameters

ClassType