Class
LightProjectModule

Definition

Namespace:ArtOfTest.WebAii.Design.ProjectModel.Providers.Modules

Assembly:ArtOfTest.WebAii.Design.dll

Syntax:

cs-api-definition
public class LightProjectModule : ModuleBase

Inheritance: objectModuleBaseLightProjectModule

Inherited Members ModuleBase.TriggerAsyncFunc<T>(Func<T>)ModuleBase.TriggerAsyncAction(Action)ModuleBase.InvokeOnUIThread(Action, bool)

Properties

FileSystemProvider

Declaration

cs-api-definition
protected FileSystemProvider FileSystemProvider { get; }

Property Value

FileSystemProvider

IsProjectLoaded

True if the all the light elements are loaded

Declaration

cs-api-definition
public bool IsProjectLoaded { get; }

Property Value

bool

LightProjectElements

Gets all light project elements such as LightTest(s), LightFolder(s), LightDataSource(s) and LightProject

Declaration

cs-api-definition
public List<LightProjectElement> LightProjectElements { get; }

Property Value

List<LightProjectElement>

The light project elements.

Project

Declaration

cs-api-definition
protected override Project Project { get; }

Property Value

Project

Overrides ModuleBase.Project

SourceControlProvider

Declaration

cs-api-definition
protected SourceControlProviderBase SourceControlProvider { get; }

Property Value

SourceControlProviderBase

TestAsStepReferences

Gets the test as step references extracted by the load-on demand process

Declaration

cs-api-definition
public IList<LightTestAsStepReference> TestAsStepReferences { get; }

Property Value

IList<LightTestAsStepReference>

The test as step references.

Methods

CopyElements(LightFolder, params LightProjectElement[])

Copies the elements files and loads the copies.

Declaration

cs-api-definition
public void CopyElements(LightFolder parentFolder, params LightProjectElement[] projectElements)

Parameters

parentFolder

LightFolder

The parent folder.

projectElements

LightProjectElement[]

The project elements.

CreateCodeFile(string)

Creates LightFolder object.

Declaration

cs-api-definition
public LightCodeFile CreateCodeFile(string path)

Parameters

path

string

The path.

Returns

LightCodeFile

LightCodeFile

CreateFolder(string, bool)

Creates LightFolder object.

Declaration

cs-api-definition
public void CreateFolder(string path, bool folderCreated)

Parameters

path

string

The path.

folderCreated

bool

Whether the directory physical creation has already been handled (Visual Studio context).

CreateTest(TestType, string)

Creates LightTest.

Declaration

cs-api-definition
public LightTest CreateTest(TestType type, string parentFolder)

Parameters

type

TestType

The type.

parentFolder

string

The parent folder.

Returns

LightTest

DeleteCodeBehindFile(LightTest)

Deletes the code behind file.

Declaration

cs-api-definition
public void DeleteCodeBehindFile(LightTest lTest)

Parameters

lTest

LightTest

The LightTest.

DeleteExternalCodeFile(LightCodeFile)

Deletes the external code file.

Declaration

cs-api-definition
public void DeleteExternalCodeFile(LightCodeFile lCodeFile)

Parameters

lCodeFile

LightCodeFile

The LightCodeFile.

DeleteFolder(LightFolder)

Deletes the LightFolder.

Declaration

cs-api-definition
public void DeleteFolder(LightFolder lFolder)

Parameters

lFolder

LightFolder

The LightFolder.

DeleteTest(LightTest, bool)

Deletes LightTest, also removes the test's elements and code from the CodeService

Declaration

cs-api-definition
public void DeleteTest(LightTest lTest, bool deleteFromDisk)

Parameters

lTest

LightTest

The l test.

deleteFromDisk

bool

ExcludeProjectElements(IList<LightProjectElement>)

Excludes the selected project elements.

Declaration

cs-api-definition
public void ExcludeProjectElements(IList<LightProjectElement> elements)

Parameters

elements

IList<LightProjectElement>

The elements.

FindLightTest(string)

Declaration

cs-api-definition
public LightTest FindLightTest(string path)

Parameters

path

string

Returns

LightTest

FixTestAsStepByLightTest(LightTest, HashSet<LightProjectElement>)

Fixes the test as step references by light test.

Declaration

cs-api-definition
public void FixTestAsStepByLightTest(LightTest lightTest, HashSet<LightProjectElement> dirtyTestsSet)

Parameters

lightTest

LightTest

The light test.

dirtyTestsSet

HashSet<LightProjectElement>

The dirty tests set.

HookUpFileSystemProviderEvents()

Declaration

cs-api-definition
protected virtual void HookUpFileSystemProviderEvents()

ImportCodeFile(ImportCodeFileArgs)

Imports test. The test is upgraded if neccessary and creates LightTest wrapper.

Declaration

cs-api-definition
public LightCodeFile ImportCodeFile(ImportCodeFileArgs args)

Parameters

args

ImportCodeFileArgs

The args.

Returns

LightCodeFile

LightCodeFile

ImportTest(ImportTestArgs)

Imports test. The test is upgraded if neccessary and creates LightTest wrapper.

Declaration

cs-api-definition
public LightTest ImportTest(ImportTestArgs args)

Parameters

args

ImportTestArgs

The args.

Returns

LightTest

LightTest

MoveCodeFile(LightCodeFile, string)

Moves the test.

Declaration

cs-api-definition
public void MoveCodeFile(LightCodeFile lCodeFile, string newCodeFilePath)

Parameters

lCodeFile

LightCodeFile

The l code file.

newCodeFilePath

string

The new code file path.

MoveFolder(LightFolder, string)

Moves the folder.

Declaration

cs-api-definition
public void MoveFolder(LightFolder lFolder, string newFolderPath)

Parameters

lFolder

LightFolder

The l folder.

newFolderPath

string

The new folder path.

MoveTest(LightTest, string)

Moves the test.

Declaration

cs-api-definition
public void MoveTest(LightTest lTest, string newTestPath)

Parameters

lTest

LightTest

The l test.

newTestPath

string

The new test path.

OnFolderDiscovered(LightFolder)

Declaration

cs-api-definition
protected virtual void OnFolderDiscovered(LightFolder lightFolder)

Parameters

lightFolder

LightFolder

OnLightCodeFileLoaded(LightCodeFile)

Declaration

cs-api-definition
protected virtual void OnLightCodeFileLoaded(LightCodeFile lightCodeFile)

Parameters

lightCodeFile

LightCodeFile

OnLightTestDeleted(LightTest)

Declaration

cs-api-definition
protected void OnLightTestDeleted(LightTest lTest)

Parameters

lTest

LightTest

OnLightTestDeleting(LightTest)

Declaration

cs-api-definition
protected void OnLightTestDeleting(LightTest lTest)

Parameters

lTest

LightTest

OnLightTestLoaded(LightTest)

Declaration

cs-api-definition
protected virtual void OnLightTestLoaded(LightTest lightTest)

Parameters

lightTest

LightTest

OnLightTestMoved(LightTestMovedArgs)

Declaration

cs-api-definition
protected void OnLightTestMoved(LightTestMovedArgs args)

Parameters

args

LightTestMovedArgs

OnLightTestsLoaded()

Declaration

cs-api-definition
protected virtual void OnLightTestsLoaded()

OnProjectElementManuallyDeleted(LightProjectElement)

Declaration

cs-api-definition
protected virtual void OnProjectElementManuallyDeleted(LightProjectElement element)

Parameters

element

LightProjectElement

OnProjectLoaded(Project)

Declaration

cs-api-definition
protected virtual void OnProjectLoaded(Project project)

Parameters

project

Project

RenameCodeFile(LightCodeFile, string)

Renames the test.

Declaration

cs-api-definition
public void RenameCodeFile(LightCodeFile lCodeFile, string newName)

Parameters

lCodeFile

LightCodeFile

The light code file.

newName

string

The new name.

RenameFolder(LightFolder, string)

Renames the folder.

Declaration

cs-api-definition
public void RenameFolder(LightFolder lFolder, string newName)

Parameters

lFolder

LightFolder

The l folder.

newName

string

The new name.

RenameTest(LightTest, string)

Renames the test.

Declaration

cs-api-definition
public void RenameTest(LightTest lTest, string newName)

Parameters

lTest

LightTest

The l test.

newName

string

The new name.

SaveProject()

Saves all LightTests and code files in the LightProject.

Declaration

cs-api-definition
public void SaveProject()

SaveProjectAsync()

Saves all LightTests and code files in the LightProject in async mode.

Declaration

cs-api-definition
public Task SaveProjectAsync()

Returns

Task

SaveProjectElements(IList<LightProjectElement>)

Saves all light elements in the LightProject.

Declaration

cs-api-definition
public void SaveProjectElements(IList<LightProjectElement> elements)

Parameters

elements

IList<LightProjectElement>

The elements.

SaveProjectElementsAsync(IList<LightProjectElement>)

Saves all light elements in the LightProject in async mode.

Declaration

cs-api-definition
public Task SaveProjectElementsAsync(IList<LightProjectElement> elements)

Parameters

elements

IList<LightProjectElement>

The elements.

Returns

Task

SmartRefresh(bool)

Smart the refresh all LightTest(s), LightFolder(s) and LightDataSource(s)

Declaration

cs-api-definition
public IList<string> SmartRefresh(bool updateCodeBehind = true)

Parameters

updateCodeBehind

bool

Returns

IList<string>

UnHookUpFileSystemProviderEvents()

Declaration

cs-api-definition
protected virtual void UnHookUpFileSystemProviderEvents()

Events

FolderDiscovered

Occurs foreach 'user' folder discovery. This is not triggerd for reserved forlders such as 'Bin', 'TestLists', Results etc...

Declaration

cs-api-definition
public event Action<LightFolder> FolderDiscovered

Event Value

Action<LightFolder>

LightCodeFileLoaded

Occurs foreach LightCodeFile during the LightCodeFile(s) creation.

Declaration

cs-api-definition
public event Action<LightCodeFile> LightCodeFileLoaded

Event Value

Action<LightCodeFile>

LightCodeFileMoved

Occurs when code file location is changed.

Declaration

cs-api-definition
public event Action<LightCodeFile, string> LightCodeFileMoved

Event Value

Action<LightCodeFile, string>

LightProjectLoaded

Occurs when all light project elements(LightTests, LightFolders, LightDataSources) are loaded

Declaration

cs-api-definition
public event Action<Project> LightProjectLoaded

Event Value

Action<Project>

LightTestDeleted

Occurs after the LightTest is deleted and removed from the providers system, this is also triggered for excluded tests.

Declaration

cs-api-definition
public event Action<LightTest> LightTestDeleted

Event Value

Action<LightTest>

LightTestDeleting

Occurs before the LightTest is deleted and removed from the providers system, this is also triggered for excluded tests.

Declaration

cs-api-definition
public event Action<LightTest> LightTestDeleting

Event Value

Action<LightTest>

LightTestDirtyStateChanged

Occurs when a light test gets modified and will need to be saved.

Declaration

cs-api-definition
public event Action<LightTest, bool> LightTestDirtyStateChanged

Event Value

Action<LightTest, bool>

LightTestLoaded

Occurs foreach LightTest during the LightTest(s) creation.

Declaration

cs-api-definition
public event Action<LightTest> LightTestLoaded

Event Value

Action<LightTest>

LightTestMoved

Occurs when test location is changed.

Declaration

cs-api-definition
public event Action<LightTestMovedArgs> LightTestMoved

Event Value

Action<LightTestMovedArgs>

LightTestsLoaded

/// Occurs when all discovered tests in the project are loaded as LightTest(s).

Declaration

cs-api-definition
public event Action LightTestsLoaded

Event Value

Action

ProjectElementManuallyDeleted

Occurs when a project element was deleted by the user.

Declaration

cs-api-definition
public event Action<LightProjectElement> ProjectElementManuallyDeleted

Event Value

Action<LightProjectElement>

In this article
DefinitionPropertiesFileSystemProviderIsProjectLoadedLightProjectElementsProjectSourceControlProviderTestAsStepReferencesMethodsCopyElements(LightFolder, params LightProjectElement[])CreateCodeFile(string)CreateFolder(string, bool)CreateTest(TestType, string)DeleteCodeBehindFile(LightTest)DeleteExternalCodeFile(LightCodeFile)DeleteFolder(LightFolder)DeleteTest(LightTest, bool)ExcludeProjectElements(IList<LightProjectElement>)FindLightTest(string)FixTestAsStepByLightTest(LightTest, HashSet<LightProjectElement>)HookUpFileSystemProviderEvents()ImportCodeFile(ImportCodeFileArgs)ImportTest(ImportTestArgs)MoveCodeFile(LightCodeFile, string)MoveFolder(LightFolder, string)MoveTest(LightTest, string)OnFolderDiscovered(LightFolder)OnLightCodeFileLoaded(LightCodeFile)OnLightTestDeleted(LightTest)OnLightTestDeleting(LightTest)OnLightTestLoaded(LightTest)OnLightTestMoved(LightTestMovedArgs)OnLightTestsLoaded()OnProjectElementManuallyDeleted(LightProjectElement)OnProjectLoaded(Project)RenameCodeFile(LightCodeFile, string)RenameFolder(LightFolder, string)RenameTest(LightTest, string)SaveProject()SaveProjectAsync()SaveProjectElements(IList<LightProjectElement>)SaveProjectElementsAsync(IList<LightProjectElement>)SmartRefresh(bool)UnHookUpFileSystemProviderEvents()EventsFolderDiscoveredLightCodeFileLoadedLightCodeFileMovedLightProjectLoadedLightTestDeletedLightTestDeletingLightTestDirtyStateChangedLightTestLoadedLightTestMovedLightTestsLoadedProjectElementManuallyDeleted
Not finding the help you need?
Contact Support