Class CodeFactoryConfigurationLoader

Utility class that loads a CFA file libraries into memory and creates instances of all the visual studio actions and makes them available to visual studio for usage.

Inheritance
object
CodeFactoryConfigurationLoader
Inherited Members
Namespace: CodeFactory.WinVs.Loader
Assembly: CodeFactory.WinVs.dll
Syntax
public static class CodeFactoryConfigurationLoader

Fields

CodeFactoryDirectoryName

Constant that holds the name of the code factory directory.

Declaration
public const string CodeFactoryDirectoryName = "CodeFactory"
Field Value
Type Description
string

CodeFactoryExtension

Constant that holds the name of the code factory file extension.

Declaration
public const string CodeFactoryExtension = ".cfa"
Field Value
Type Description
string

Methods

GetAssembliesToLoadFromPackage(string, VsFactoryConfiguration)

Helper method that gets the list of all the assembly files that need to copied from the code factory package.

Declaration
public static List<string> GetAssembliesToLoadFromPackage(string packageDirectory, VsFactoryConfiguration config)
Parameters
Type Name Description
string packageDirectory

The target directory all files are to be copied to.
VsFactoryConfiguration config

The factory configuration to load the files from.
Returns
Type Description
List<string>

List of the assembly and support files to load, or null if a load failure error occurred.

LoadCodeFactoryConfiguration(string, string, IVsActions)

Loads a code factory configuration into memory and returns the target visual studio actions to be used by code factory.

Declaration
public static IVsCodeFactoryLoadStatus LoadCodeFactoryConfiguration(string codeFactoryPackageFile, string unpackDirectory, IVsActions actions)
Parameters
Type Name Description
string codeFactoryPackageFile

The fully qualified path to the code factory package file.
string unpackDirectory

The fully qualified path to the unpackDirectory for the code factory libraries.
IVsActions actions

The implementation of the actions interface to be injected into each created visual studio action.
Returns
Type Description
IVsCodeFactoryLoadStatus

LoadFactoryLibraries(VsFactoryConfiguration, string)

Loads the factory libraries into the running visual studio instance.

Declaration
public static LibraryLoadStatus LoadFactoryLibraries(VsFactoryConfiguration config, string packageDirectory)
Parameters
Type Name Description
VsFactoryConfiguration config

The code factory configuration to load assemblies from.
string packageDirectory

The directory where the packages are found.
Returns
Type Description
LibraryLoadStatus

Data object that holds the status of loaded factory libraries. This will always return an instance of the status.

LocateFactoryPackage(string)

Helper method that determines if a code factory extension file is located in the directory. This will return the first CFA file that is located in the directory.

Declaration
public static string LocateFactoryPackage(string sourceDirectory)
Parameters
Type Name Description
string sourceDirectory

The directory to search for the code factory extension file.
Returns
Type Description
string

The fully qualified path to the code factory extension file, or null if no file was found.