TeamControlium - Utilities library
 | Detokenizer Class |
[This is preliminary documentation and is subject to change.]
+Detokeniser Class
Inheritance HierarchyInheritance Hierarchy
Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0SyntaxProperties
TopSee Also
TeamControlium - Utilities library
| Detokeniser Class |
[This is preliminary documentation and is subject to change.]
Processes given strings to process and resolve all tokens in passed strings.
-
Inheritance Hierarchy+
Inheritance HierarchyNamespace: TeamControlium.Utilities
Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0
SyntaxC#
public static class Detokenizer
The Detokenizer type exposes the following members.
Properties|
+ Utilities.net (in Utilities.net.dll) Version: 2.0.0Syntax C# public static class Detokeniser The Detokeniser type exposes the following members. Properties
Methods
See AlsoReferenceSend comments on this topic to
TeamControlium
diff --git a/Docs/html/05b35a51-d7bf-318a-283e-b726721b2d99.htm b/Docs/html/05b35a51-d7bf-318a-283e-b726721b2d99.htm
deleted file mode 100644
index 493433b..0000000
--- a/Docs/html/05b35a51-d7bf-318a-283e-b726721b2d99.htm
+++ /dev/null
@@ -1,17 +0,0 @@
-TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
- Gets or sets delegate to write debug data to if WriteToConsole is false.
- - Namespace: - TeamControlium.Utilities - Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxRemarks
- Note. If the delegate throws an exception, allow the exception to ripple up. Log class will handle the exception and write details to
- the OS event logging system.
- See AlsoTeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ Gets or sets delegate to write debug data to if LogToConsole is false.
+ + Namespace: + TeamControlium.Utilities + Assembly: + Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxRemarks
+ Note. If the delegate throws an exception, allow the exception to ripple up. Log class will handle the exception and write details to
+ the OS event logging system.
+ See AlsoParameters
Type Parameters
Return ValueType: BooleanTrue if sucessful, False if not or type differs to expected. RemarksIf method fails and returns False, RepositoryLastTryException can be used to obtain exception thrown. See AlsoParameters
Type Parameters
Return ValueType: BooleanTrue if successful, False if not or type differs to expected. RemarksIf method fails and returns False, RepositoryLastTryException can be used to obtain exception thrown. See AlsoRemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO refeferences etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning. See AlsoParameters
RemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO references etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning. See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
Levels of logging - Verbose (Maximum) to Exception (Minimum). If level of text being written to
logging is equal to, or higher than the current LoggingLevel the text is written. This is used to filter logging so that only entries to log are made if the level of the write is equal - or greater than the logging level set by LoggingLevel. + or greater than the logging level set by LoggingLevel. Namespace: TeamControlium.Utilities @@ -10,13 +10,13 @@ Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxC# public enum LogLevels Members
See AlsoReferenceSend comments on this topic to
diff --git a/Docs/html/83ae4adb-e73a-de81-e262-e38b2b8c1777.htm b/Docs/html/1b7db609-a123-dcf1-965c-e3582fac0013.htm
similarity index 51%
rename from Docs/html/83ae4adb-e73a-de81-e262-e38b2b8c1777.htm
rename to Docs/html/1b7db609-a123-dcf1-965c-e3582fac0013.htm
index 68ced51..a942e56 100644
--- a/Docs/html/83ae4adb-e73a-de81-e262-e38b2b8c1777.htm
+++ b/Docs/html/1b7db609-a123-dcf1-965c-e3582fac0013.htm
@@ -1,13 +1,13 @@
- TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
Writes details of a caught exception to the active debug log at level Error Namespace: TeamControlium.Utilities Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxC# public static void WriteLogException( + Utilities.net (in Utilities.net.dll) Version: 2.0.0 Parameters
Remarks
If current error logging level is FrameworkDebug the full
exception is written, including stack trace details etc. With any other Log Level only the exception message is written if an exception is thrown during write, Logger @@ -15,9 +15,9 @@ ExamplesC# catch (InvalidHostURI ex) { // Log exception and abort the test - we cant talk to the remote Selenium server - Logger.WriteLogException(ex,"Given up trying to connect to [{0}]",Wherever); + Logger.LogException(ex,"Given up trying to connect to [{0}]",Wherever); toolWrapper.AbortTest("Cannot connect to remote Selenium host"); -} See AlsoSee AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ Gets or sets a value indicating whether log data is written to Console. + If true log data is written to the Console (STDOUT) + If false and LogOutputDelegate has been defined, no log data is written to Console. If LogOutputDelegate has + NOT been defined, LogToConsole false is ignored and output is STILL written to Console. + Namespace: + TeamControlium.Utilities + Assembly: + Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxRemarks
+ The default is true (log data to be written to the console)
+ See AlsoSyntaxC# public static class Log The Log type exposes the following members. Properties
Methods
Methods
See AlsoReferenceSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] The Detokenizer type exposes the following members. Properties
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] Properties
See Also | Name | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 | ItemString |
+ Gets or sets the non-categorised item in the required repository.
+ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ItemString, String |
+ Gets or sets the named item in the required repository's category.
+ |
See AlsoRemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO refeferences etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning.
See AlsoParameters
- overwriteExistingItems
- Type: SystemBoolean
Indicates if existing data should be overwritten. An exception is thrown if false and any existing item/s would be overwritten.
Return Value
Type: BooleanTrue if successful clone or false if not (See RepositoryLastTryException for exception thrown if false returned).
RemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO references etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning.
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
| LogWriteLogException Method (Exception) |
[This is preliminary documentation and is subject to change.]
- Writes details of a caught exception to the active debug log at level Error
- Namespace: - TeamControlium.Utilities
- Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0
SyntaxC#
public static void WriteLogException( - Exception ex -)
Parameters
- ex
- Type: SystemException
Exception being logged
Remarks
- If current error logging level is FrameworkDebug the full
- exception is written, including stack-trace etc.
- With any other Log Level only the exception message is written if an exception is thrown during write, Logger - attempts to write the error details if able. -
- With any other Log Level only the exception message is written if an exception is thrown during write, Logger - attempts to write the error details if able. -
ExamplesC#
catch (InvalidHostURI ex) -{ - // Log exception and abort the test - we cant talk to the remote Selenium server - Logger.WriteLogException(ex,"Connecting to Selenium host"); - toolWrapper.AbortTest("Cannot connect to remote Selenium host"); -}
See AlsoParameters
- categoryName
- Type: SystemString
Name of category to retreive data item from - itemName
- Type: SystemString
Name of data item to retrieve - item
- Type: T
Item found (if succesful) or null. Type checked with expected type to ensure type compatibility.
Type Parameters
- T
- Expected type of data item
Return Value
Type: BooleanTrue if sucessful, False if not or type differs to expected.
RemarksIf method fails and returns False, RepositoryLastTryException can be used to obtain exception thrown.
See AlsoParameters
- categoryName
- Type: SystemString
Name of category to retrieve data item from - itemName
- Type: SystemString
Name of data item to retrieve - item
- Type: T
Item found (if successful) or null. Type checked with expected type to ensure type compatibility.
Type Parameters
- T
- Expected type of data item
Return Value
Type: BooleanTrue if successful, False if not or type differs to expected.
RemarksIf method fails and returns False, RepositoryLastTryException can be used to obtain exception thrown.
See AlsoRemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO refeferences etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning.
See AlsoParameters
- categoryName
- Type: SystemString
Name of category to be copied. - overwriteExistingItems
- Type: SystemBoolean
Indicates if existing data should be overwritten. An exception is thrown if false and any existing item/s would be overwritten.
Return Value
Type: BooleanTrue if successful clone or false if not (See RepositoryLastTryException for exception thrown if false returned).
RemarksA deep clone is performed to copy items. However, it should be noted that complex data items (EG. IO references etc) may clone incorrectly. Complex type cloning should be verified during test framework development to ensure correct cloning.
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
| Log Properties |
[This is preliminary documentation and is subject to change.]
The Log type exposes the following members.
Properties|
+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] The Log type exposes the following members. Properties
See Also |
|---|
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
| LogLogException Method (Exception) |
[This is preliminary documentation and is subject to change.]
+ Writes details of a caught exception to the active debug log at level Error
+ Namespace: + TeamControlium.Utilities
+ Assembly: + Utilities.net (in Utilities.net.dll) Version: 2.0.0
SyntaxC#
public static void LogException( + Exception ex +)
Parameters
- ex
- Type: SystemException
Exception being logged
Remarks
+ If current error logging level is FrameworkDebug the full
+ exception is written, including stack-trace etc.
+ With any other Log Level only the exception message is written if an exception is thrown during write, Logger + attempts to write the error details if able. +
+ With any other Log Level only the exception message is written if an exception is thrown during write, Logger + attempts to write the error details if able. +
ExamplesC#
catch (InvalidHostURI ex) +{ + // Log exception and abort the test - we cant talk to the remote Selenium server + Logger.LogException(ex,"Connecting to Selenium host"); + toolWrapper.AbortTest("Cannot connect to remote Selenium host"); +}
See AlsoTeamControlium - Utilities library
| DetokenizerCustomTokenProcessor Property |
[This is preliminary documentation and is subject to change.]
+Detokeniser.CustomTokenProcessor Property
Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0SyntaxRemarksSee AlsoLog Methods
Methods
TeamControlium - Utilities library
| DetokeniserCustomTokenProcessor Property |
[This is preliminary documentation and is subject to change.]
Gets or sets delegate for processing custom tokens if required. If set, delegate is called before internal token processing to allow overriding if required.
Namespace: TeamControlium.Utilities
Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0
SyntaxC#
public static Func<char, string[], string> CustomTokenProcessor { get; set; }
Property Value
Type: FuncChar, String, StringRemarks Assigned delegate must take char (delimiter being used) and the token (split into an array using delimiter as separator) and return the resolved token text.
- If the token cannot be resolved, delegate should return a null. Any exception should be allowed to ripple up to enable the Utilities Detokenizer to handle
- the error.
See AlsoSend comments on this topic to
+ Utilities.net (in Utilities.net.dll) Version: 2.0.0SyntaxRemarksSee Also
SyntaxC#
public static Func<char, string[], string> CustomTokenProcessor { get; set; }
Property Value
Type: FuncChar, String, StringRemarks Assigned delegate must take char (delimiter being used) and the token (split into an array using delimiter as separator) and return the resolved token text.
+ If the token cannot be resolved, delegate should return a null. Any exception should be allowed to ripple up to enable the Utilities Detokeniser to handle
+ the error.
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
| Log Methods |
[This is preliminary documentation and is subject to change.]
The Log type exposes the following members.
Methods|
+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] The Log type exposes the following members. Methods
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] [Missing <summary> documentation for "T:TeamControlium.Utilities.Repository.DynamicItems`1"] Inheritance Hierarchy+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ Provides a List type in the repository for list properties. Class is fully thread-safe and ensures thread safety in all interactions with repository.
+ Inheritance HierarchyNamespace: TeamControlium.Utilities Assembly: Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxC# public class DynamicItems<dynamic> - Type Parameters
The RepositoryDynamicItemsdynamic type exposes the following members. Constructors
See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
+ TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.]
Writes a line of data to the active debug log.
Data can be formatted in the standard string.format syntax. If an exception is thrown during write, Logger
attempts to write the error details if able.
@@ -6,12 +6,12 @@
Namespace:
TeamControlium.Utilities Assembly: - Utilities.net (in Utilities.net.dll) Version: 2.0.0 SyntaxC# public static void WriteLogLine( - LogLogLevels logLevel, + Utilities.net (in Utilities.net.dll) Version: 2.0.0 Parameters
RemarksIf arguments are passed in but there is an error formatting the text line during resolution of the arguments they will be ignored and the text line written out without arguments. ExamplesLogException a line of data from our test:
+ C# Logger.LogWriteLine(LogLevels.TestDebug, "Select member using key (Member: {0})","90986754332"); See AlsoSend comments on this topic to
TeamControlium
TeamControlium - Utilities library
[This is preliminary documentation and is subject to change.] Classes
|
|---|
