C# Class PSTestLib.PSCmdletBase

Description of PSCmdletBase.

Inheritance: System.Management.Automation.PSCmdlet

Show file Open project: apetrovskiy/STUPS Class Usage Examples

Private Properties

Property	Type	Description

Public Methods

Method	Description
CmdletName ( PSCmdletBase cmdlet ) : string
ConvertObjectArrayToString ( object array ) : string
SetCmdletParametersCheckingOn ( bool check ) : void
WriteError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
WriteError ( PSCmdletBase cmdlet, string message, string errorId, ErrorCategory category, bool terminating ) : void
WriteObject ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
WriteObject ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
WriteObject ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
WriteObject ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
WriteObject ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
WriteObject ( PSCmdletBase cmdlet, List
WriteObject ( PSCmdletBase cmdlet, object outputObject ) : void
WriteObject ( PSCmdletBase cmdlet, string outputObject ) : void
WriteTrace ( PSCmdletBase cmdlet, object obj ) : void
WriteTraceTemp ( object obj ) : void
WriteVerbose ( PSCmdletBase cmdlet, object obj ) : void
WriteVerbose ( PSCmdletBase cmdlet, string text ) : void
runSBAction ( ScriptBlock sb, AutomationElement src, AutomationEventArgs e ) : void
runSBActionWithParams ( ScriptBlock sb, object parameters ) : void
runSBEvent ( ScriptBlock sb, AutomationElement src, AutomationEventArgs e ) : void
runScriptBlocks ( List scriptblocks, PSCmdletBase cmdlet, bool eventHandlers, object parameters ) : void
writeSingleError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
writeSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void

Protected Methods

Method	Description
AfterWriteCollection ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
AfterWriteCollection ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
AfterWriteCollection ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
AfterWriteCollection ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
AfterWriteCollection ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
AfterWriteCollection ( PSCmdletBase cmdlet, List
AfterWriteCollection ( PSCmdletBase cmdlet, object outputObjectCollection ) : void
AfterWriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
BeforeWriteCollection ( PSCmdletBase cmdlet, List
BeforeWriteCollection ( PSCmdletBase cmdlet, object outputObjectCollection ) : void
BeforeWriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
BeginProcessing ( ) : void
CheckCmdletParameters ( ) : void
CheckSingleObject ( PSCmdletBase cmdlet, object outputObject ) : bool
CmdletSignature ( PSCmdletBase cmdlet ) : string
GetGeneratedTestResultNameByPosition ( string initialString, int position ) : string
SaveEventInput ( AutomationElement src, AutomationEventArgs e, string programmaticName, bool infoAdded ) : void
WriteErrorMethod010RunScriptBlocks ( PSCmdletBase cmdlet ) : void
WriteErrorMethod020SetTestResult ( PSCmdletBase cmdlet, ErrorRecord errorRecord ) : void
WriteErrorMethod030ChangeTimeoutSettings ( PSCmdletBase cmdlet, bool terminating ) : void
WriteErrorMethod040AddErrorToErrorList ( PSCmdletBase cmdlet, ErrorRecord errorRecord ) : void
WriteErrorMethod045OnErrorScreenshot ( PSCmdletBase cmdlet ) : void
WriteErrorMethod050OnErrorDelay ( PSCmdletBase cmdlet ) : void
WriteErrorMethod060OutputError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
WriteErrorMethod070Report ( PSCmdletBase cmdlet ) : void
WriteLog ( LogLevels logLevel, string logRecord ) : void
WriteSingleError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
WriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
runTwoScriptBlockCollections ( ScriptBlock scriptblocksSet1, ScriptBlock scriptblocksSet2, PSCmdletBase cmdlet, object parameters ) : void

Method Details

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	System.Collections.ArrayList
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	System.Collections.Hashtable
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	ICollection
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IEnumerable
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IList
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, List
cmdlet	PSCmdletBase
outputObjectCollection	List
return	void

AfterWriteCollection() protected abstract method

protected abstract AfterWriteCollection ( PSCmdletBase cmdlet, object outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	object
return	void

AfterWriteSingleObject() protected abstract method

protected abstract AfterWriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
cmdlet	PSCmdletBase
outputObject	object
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	System.Collections.ArrayList
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	System.Collections.Hashtable
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	ICollection
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IEnumerable
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IList
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, List
cmdlet	PSCmdletBase
outputObjectCollection	List
return	void

BeforeWriteCollection() protected abstract method

protected abstract BeforeWriteCollection ( PSCmdletBase cmdlet, object outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	object
return	void

BeforeWriteSingleObject() protected abstract method

protected abstract BeforeWriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
cmdlet	PSCmdletBase
outputObject	object
return	void

BeginProcessing() protected method

protected BeginProcessing ( ) : void
return	void

CheckCmdletParameters() protected method

protected CheckCmdletParameters ( ) : void
return	void

CheckSingleObject() protected abstract method

protected abstract CheckSingleObject ( PSCmdletBase cmdlet, object outputObject ) : bool
cmdlet	PSCmdletBase
outputObject	object
return	bool

CmdletName() public method

public CmdletName ( PSCmdletBase cmdlet ) : string
cmdlet	PSCmdletBase
return	string

CmdletSignature() protected method

protected CmdletSignature ( PSCmdletBase cmdlet ) : string
cmdlet	PSCmdletBase
return	string

ConvertObjectArrayToString() public method

public ConvertObjectArrayToString ( object array ) : string
array	object
return	string

GetGeneratedTestResultNameByPosition() protected method

protected GetGeneratedTestResultNameByPosition ( string initialString, int position ) : string
initialString	string
position	int
return	string

SaveEventInput() protected method

protected SaveEventInput ( AutomationElement src, AutomationEventArgs e, string programmaticName, bool infoAdded ) : void
src	AutomationElement
e	AutomationEventArgs
programmaticName	string
infoAdded	bool
return	void

SetCmdletParametersCheckingOn() public static method

public static SetCmdletParametersCheckingOn ( bool check ) : void
check	bool
return	void

WriteError() public method

public WriteError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
terminating	bool
return	void

WriteError() public method

public WriteError ( PSCmdletBase cmdlet, string message, string errorId, ErrorCategory category, bool terminating ) : void
cmdlet	PSCmdletBase
message	string
errorId	string
category	ErrorCategory
terminating	bool
return	void

WriteErrorMethod010RunScriptBlocks() protected abstract method

protected abstract WriteErrorMethod010RunScriptBlocks ( PSCmdletBase cmdlet ) : void
cmdlet	PSCmdletBase
return	void

WriteErrorMethod020SetTestResult() protected abstract method

protected abstract WriteErrorMethod020SetTestResult ( PSCmdletBase cmdlet, ErrorRecord errorRecord ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
return	void

WriteErrorMethod030ChangeTimeoutSettings() protected abstract method

protected abstract WriteErrorMethod030ChangeTimeoutSettings ( PSCmdletBase cmdlet, bool terminating ) : void
cmdlet	PSCmdletBase
terminating	bool
return	void

WriteErrorMethod040AddErrorToErrorList() protected abstract method

protected abstract WriteErrorMethod040AddErrorToErrorList ( PSCmdletBase cmdlet, ErrorRecord errorRecord ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
return	void

WriteErrorMethod045OnErrorScreenshot() protected abstract method

protected abstract WriteErrorMethod045OnErrorScreenshot ( PSCmdletBase cmdlet ) : void
cmdlet	PSCmdletBase
return	void

WriteErrorMethod050OnErrorDelay() protected abstract method

protected abstract WriteErrorMethod050OnErrorDelay ( PSCmdletBase cmdlet ) : void
cmdlet	PSCmdletBase
return	void

WriteErrorMethod060OutputError() protected abstract method

protected abstract WriteErrorMethod060OutputError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
terminating	bool
return	void

WriteErrorMethod070Report() protected abstract method

protected abstract WriteErrorMethod070Report ( PSCmdletBase cmdlet ) : void
cmdlet	PSCmdletBase
return	void

WriteLog() protected abstract method

protected abstract WriteLog ( LogLevels logLevel, string logRecord ) : void
logLevel	LogLevels
logRecord	string
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, ArrayList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	ArrayList
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, Hashtable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	Hashtable
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, ICollection outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	ICollection
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, IEnumerable outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IEnumerable
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, IList outputObjectCollection ) : void
cmdlet	PSCmdletBase
outputObjectCollection	IList
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, List
cmdlet	PSCmdletBase
outputObjectCollection	List
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, object outputObject ) : void
cmdlet	PSCmdletBase
outputObject	object
return	void

WriteObject() public method

public WriteObject ( PSCmdletBase cmdlet, string outputObject ) : void
cmdlet	PSCmdletBase
outputObject	string
return	void

WriteSingleError() protected abstract method

protected abstract WriteSingleError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
terminating	bool
return	void

WriteSingleObject() protected abstract method

protected abstract WriteSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
cmdlet	PSCmdletBase
outputObject	object
return	void

WriteTrace() public method

public WriteTrace ( PSCmdletBase cmdlet, object obj ) : void
cmdlet	PSCmdletBase
obj	object
return	void

WriteTraceTemp() public static method

public static WriteTraceTemp ( object obj ) : void
obj	object
return	void

WriteVerbose() public method

public WriteVerbose ( PSCmdletBase cmdlet, object obj ) : void
cmdlet	PSCmdletBase
obj	object
return	void

WriteVerbose() public method

public WriteVerbose ( PSCmdletBase cmdlet, string text ) : void
cmdlet	PSCmdletBase
text	string
return	void

runSBAction() public method

public runSBAction ( ScriptBlock sb, AutomationElement src, AutomationEventArgs e ) : void
sb	ScriptBlock
src	AutomationElement
e	AutomationEventArgs
return	void

runSBActionWithParams() public method

public runSBActionWithParams ( ScriptBlock sb, object parameters ) : void
sb	ScriptBlock
parameters	object
return	void

runSBEvent() public method

public runSBEvent ( ScriptBlock sb, AutomationElement src, AutomationEventArgs e ) : void
sb	ScriptBlock
src	AutomationElement
e	AutomationEventArgs
return	void

runScriptBlocks() public method

public runScriptBlocks ( List scriptblocks, PSCmdletBase cmdlet, bool eventHandlers, object parameters ) : void
scriptblocks	List
cmdlet	PSCmdletBase
eventHandlers	bool
parameters	object
return	void

runTwoScriptBlockCollections() protected method

protected runTwoScriptBlockCollections ( ScriptBlock scriptblocksSet1, ScriptBlock scriptblocksSet2, PSCmdletBase cmdlet, object parameters ) : void
scriptblocksSet1	ScriptBlock
scriptblocksSet2	ScriptBlock
cmdlet	PSCmdletBase
parameters	object
return	void

writeSingleError() public method

public writeSingleError ( PSCmdletBase cmdlet, ErrorRecord errorRecord, bool terminating ) : void
cmdlet	PSCmdletBase
errorRecord	ErrorRecord
terminating	bool
return	void

writeSingleObject() public method

public writeSingleObject ( PSCmdletBase cmdlet, object outputObject ) : void
cmdlet	PSCmdletBase
outputObject	object
return	void