Table of Contents

Class AddInManager

Namespace
Dynamicweb.Extensibility.AddIns
Assembly
Dynamicweb.Core.dll

Manager for extensibility.

public static class AddInManager
Inheritance
AddInManager
Inherited Members

Properties

InstalledAddInsFolderPath 

public static string InstalledAddInsFolderPath { get; }

Property Value

string

LocalAddInsFolderPath 

public static string LocalAddInsFolderPath { get; }

Property Value

string

Methods

ClearCache() 

public static void ClearCache()

EnsureAssembliesAreLoaded() 

public static void EnsureAssembliesAreLoaded()

GetAddInActive(Type)

Gets the AddIn active attribute.

public static bool GetAddInActive(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInAuthors(Type)

Retrieves the list of values of the "Name" property of an add-in's AddInAuthorAttribute attributes.

public static IEnumerable<string> GetAddInAuthors(Type addInType)

Parameters

addInType Type

Add-in type.

Returns

IEnumerable<string>

GetAddInDeprecated(Type)

Gets the add in deprecated attribute.

public static bool GetAddInDeprecated(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInDescription(Type)

Gets the add in description attribute.

public static string GetAddInDescription(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

string

GetAddInFeatureEnabled(Type)

Gets whether the AddIn feature is enabled or disabled.

public static bool GetAddInFeatureEnabled(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInGroup(Type)

Gets the add in group attribute.

public static string GetAddInGroup(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

string

GetAddInIcon(Type, KnownIcon)

Gets the add in icon attribute.

public static KnownIcon GetAddInIcon(Type addInType, KnownIcon defaultIcon)

Parameters

addInType Type

Type of the add in.

defaultIcon KnownIcon

The icon should be return if addInType doesn't have AddInIconAttribute attribute

Returns

KnownIcon

GetAddInIgnore(Type)

Returns a value indicating whether the given type has an Ignore attribute; true if this is the case, false otherwise.

public static bool GetAddInIgnore(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInImage(Type)

Gets the add in image attribute.

public static string GetAddInImage(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

string

GetAddInLabel(Type)

Gets the add in label attribute.

public static string GetAddInLabel(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

string

GetAddInName(Type) 

public static string GetAddInName(Type type)

Parameters

type Type

Returns

string

GetAddInNames(Type)

Gets AddInName attributes from the specified type. Use this method if the type contains multiple Name attributes, otherwise use the GetAddInName function.

public static IEnumerable<string> GetAddInNames(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

IEnumerable<string>

GetAddInOrder(Type)

Gets the add in order attribute.

public static int GetAddInOrder(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

int

GetAddInParameterEditorInfo(Type, string)

Gets the add in parameter editor type.

public static ParameterEditorInfo? GetAddInParameterEditorInfo(Type addInType, string parameterName)

Parameters

addInType Type

Type of the add in.

parameterName string

Name of the parameter.

Returns

ParameterEditorInfo

GetAddInParameterGroupAttribute(Type, string)

Gets the AddInParameterGroupAttribute.

public static AddInParameterGroupAttribute? GetAddInParameterGroupAttribute(Type addInType, string parameterName)

Parameters

addInType Type

Type of the the Add In.

parameterName string

Name of the Add In parameter.

Returns

AddInParameterGroupAttribute

The AddInParameterGroupAttribute instance or null.

GetAddInParameterLabels(Type)

Gets the add in parameter labels.

public static IDictionary<string, string> GetAddInParameterLabels(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

IDictionary<string, string>

GetAddInParameterSectionName(Type, string)

Gets the name of the add in parameter section.

public static string GetAddInParameterSectionName(Type addInType, string parameterName)

Parameters

addInType Type

Type of the add in.

parameterName string

Name of the parameter.

Returns

string

GetAddInParameterType(object, string)

Gets the type of the add in parameter.

public static Type? GetAddInParameterType(object instance, string parameterName)

Parameters

instance object

The instance.

parameterName string

Name of the parameter.

Returns

Type

GetAddInParameterValue(object, string)

Gets the add in parameter value.

public static object? GetAddInParameterValue(object instance, string parameterName)

Parameters

instance object

The instance.

parameterName string

Name of the parameter.

Returns

object

GetAddInParameters(Type)

Gets the add in parameters.

public static IEnumerable<string> GetAddInParameters(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

IEnumerable<string>

GetAddInTargets(Type)

Retrieves the list of values of the "Path" property of an add-in's AddInTargetAttribute attributes.

public static IEnumerable<string> GetAddInTargets(Type addInType)

Parameters

addInType Type

Add-in type.

Returns

IEnumerable<string>

GetAddInUseParameterGrouping(Type)

Gets the add in use parameter grouping attribute.

public static bool GetAddInUseParameterGrouping(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInUseParameterOrdering(Type)

Gets the add in use parameter ordering attribute.

public static bool GetAddInUseParameterOrdering(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInUseParameterSectioning(Type)

Gets the add in use parameter sectioning attribute.

public static bool GetAddInUseParameterSectioning(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetAddInUseParameters(Type)

Gets the add in use parameters.

public static bool GetAddInUseParameters(Type addInType)

Parameters

addInType Type

Type of the add in.

Returns

bool

GetInstance(string, params object?[]?) 

public static object? GetInstance(string typeName, params object?[]? arguments)

Parameters

typeName string
arguments object[]

Returns

object

GetInstance(string, Type, params object?[]?) 

public static object? GetInstance(string typeName, Type baseType, params object?[]? arguments)

Parameters

typeName string
baseType Type
arguments object[]

Returns

object

GetInstance(Type, params object?[]?) 

public static object? GetInstance(Type type, params object?[]? arguments)

Parameters

type Type
arguments object[]

Returns

object

GetInstance<T>(params object?[]?) 

public static T? GetInstance<T>(params object?[]? arguments)

Parameters

arguments object[]

Returns

T

Type Parameters

T

GetInstance<T>(string) 

public static T? GetInstance<T>(string typeName)

Parameters

typeName string

Returns

T

Type Parameters

T

GetInstance<T>(string, params object?[]?) 

public static T? GetInstance<T>(string typeName, params object?[]? arguments)

Parameters

typeName string
arguments object[]

Returns

T

Type Parameters

T

GetInstance<T>(Type) 

public static T? GetInstance<T>(Type type)

Parameters

type Type

Returns

T

Type Parameters

T

GetInstance<T>(Type, params object?[]?) 

public static T? GetInstance<T>(Type type, params object?[]? arguments)

Parameters

type Type
arguments object[]

Returns

T

Type Parameters

T

GetInstances(Type, params object?[]?) 

public static IEnumerable<object> GetInstances(Type type, params object?[]? arguments)

Parameters

type Type
arguments object[]

Returns

IEnumerable<object>

GetInstances<T>() 

public static IEnumerable<T> GetInstances<T>()

Returns

IEnumerable<T>

Type Parameters

T

GetInstances<T>(params object?[]?) 

public static IEnumerable<T> GetInstances<T>(params object?[]? arguments)

Parameters

arguments object[]

Returns

IEnumerable<T>

Type Parameters

T

GetType(string) 

public static Type? GetType(string typeName)

Parameters

typeName string

Returns

Type

GetType(string, Type) 

public static Type? GetType(string typeName, Type baseType)

Parameters

typeName string
baseType Type

Returns

Type

GetTypeAlias(Type) 

public static string? GetTypeAlias(Type type)

Parameters

type Type

Returns

string

GetTypeUnvalidated(string) 

public static Type? GetTypeUnvalidated(string typeName)

Parameters

typeName string

Returns

Type

GetTypeUnvalidated(string, Type) 

public static Type? GetTypeUnvalidated(string typeName, Type baseType)

Parameters

typeName string
baseType Type

Returns

Type

GetTypeUnvalidated<T>(string) 

public static Type? GetTypeUnvalidated<T>(string typeName)

Parameters

typeName string

Returns

Type

Type Parameters

T

GetType<T>(string) 

public static Type? GetType<T>(string typeName)

Parameters

typeName string

Returns

Type

Type Parameters

T

GetTypes(Type) 

public static IEnumerable<Type> GetTypes(Type baseType)

Parameters

baseType Type

Returns

IEnumerable<Type>

GetTypesUnvalidated<T>() 

public static IEnumerable<Type> GetTypesUnvalidated<T>()

Returns

IEnumerable<Type>

Type Parameters

T

GetTypes<T>() 

public static IEnumerable<Type> GetTypes<T>()

Returns

IEnumerable<Type>

Type Parameters

T

IsBlacklistedAddIn(string) 

public static bool IsBlacklistedAddIn(string addinName)

Parameters

addinName string

Returns

bool

IsBlacklistedAddInFolder(string) 

public static bool IsBlacklistedAddInFolder(string folderName)

Parameters

folderName string

Returns

bool

LoadAddIns(string) 

public static void LoadAddIns(string addInFolderPath)

Parameters

addInFolderPath string

LoadTypeAliases() 

public static void LoadTypeAliases()

ResolveContextNameFromDirectory(string) 

public static string ResolveContextNameFromDirectory(string dir)

Parameters

dir string

Returns

string

SanitizeTypeName(string) 

public static string SanitizeTypeName(string typeName)

Parameters

typeName string

Returns

string

SanitizeTypeName(Type) 

public static string? SanitizeTypeName(Type type)

Parameters

type Type

Returns

string

SetAddInParameterValue(object, string, object?)

Sets the add in parameter value.

public static void SetAddInParameterValue(object instance, string parameterName, object? value)

Parameters

instance object

The instance.

parameterName string

Name of the parameter.

value object

The value.

SetServiceProvider(IServiceProvider) 

public static void SetServiceProvider(IServiceProvider serviceProvider)

Parameters

serviceProvider IServiceProvider

UnloadAssembly(string) 

public static ApplicationResponse<TypeOperationMessage<List<string>>> UnloadAssembly(string addInName)

Parameters

addInName string

Returns

ApplicationResponse<TypeOperationMessage<List<string>>>
Improve this doc
To top