Bin und Debug

Language/bin/Debug/DigitalData.Modules.Language.xml

@@ -0,0 +1,154 @@
+<?xml version="1.0"?>
+<doc>
+<assembly>
+<name>
+DigitalData.Modules.Language
+</name>
+</assembly>
+<members>
+<member name="T:DigitalData.Modules.Language.My.Resources.Resources">
+<summary>
+  Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
+</summary>
+</member>
+<member name="P:DigitalData.Modules.Language.My.Resources.Resources.ResourceManager">
+<summary>
+  Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
+</summary>
+</member>
+<member name="P:DigitalData.Modules.Language.My.Resources.Resources.Culture">
+<summary>
+  Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
+  Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
+</summary>
+</member>
+<member name="M:DigitalData.Modules.Language.StringEx.Truncate(System.String,System.Int32)">
+ <summary>
+ Truncates a string to the specified length if it exceeds that length.
+ </summary>
+ <param name="pString">The string</param>
+ <param name="pLength">The maximum string length</param>
+ <returns>The truncated string</returns>
+</member>
+<member name="M:DigitalData.Modules.Language.StringEx.EscapeForSQL(System.String)">
+ <summary>
+ Replaces single quotes in text for SQL Commands.
+ </summary>
+ <param name="pString">The string</param>
+ <returns>The escaped string.</returns>
+</member>
+<member name="T:DigitalData.Modules.Language.Utils">
+ <summary>
+ Provides common utility functions that do not require a specific context.
+ </summary>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ShortGUID">
+ <summary>
+ Generates a random short (8 characters) guid
+ </summary>
+ <returns>The generated guid as a String</returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ToEnum``1(System.String)">
+ <summary>
+ Converts a String value to the given Enum
+ </summary>
+ <typeparam name="T">The Enum Type</typeparam>
+ <param name="value">The string value to convert</param>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ToEnum``1(System.Int32)">
+ <summary>
+ Converts an Integer value to the given Enum
+ </summary>
+ <typeparam name="T">The Enum Type</typeparam>
+ <param name="value">The integer value to convert</param>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ToEnum``1(System.Int64)">
+ <summary>
+ Converts a Long value to the given Enum
+ </summary>
+ <typeparam name="T">The Enum Type</typeparam>
+ <param name="value">The long value to convert</param>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ToBoolean(System.String)">
+ <summary>
+ Converts a string to boolean. Accepts true and 1 as truthy values
+ </summary>
+ <param name="input">The input string</param>
+ <returns>True if input is true or 1, otherwise false.</returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.NotNull``1(``0,``0)">
+ <summary>
+ Checks a value for three different `null` values,
+ Nothing, Empty String, DBNull
+ 
+ Returns the original value if the value is not null, or `defaultValue`
+ </summary>
+ <typeparam name="T">The type of the value</typeparam>
+ <param name="value">The value</param>
+ <param name="defaultValue">The default Value</param>
+ <returns>The original value or the default value</returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.NotNull``1(System.Data.DataRow,System.String,``0)">
+ <summary>
+ Checks a Row value for three different `null` values,
+ Nothing, Empty String, DBNull
+ 
+ Returns the original value if the value is not null, or `defaultValue`
+ </summary>
+ <typeparam name="T">The type of the value</typeparam>
+ <param name="Row">The DataRow that contains the value</param>
+ <param name="Column">The column name</param>
+ <param name="DefaultValue">The default value</param>
+ <returns>The original value or the default value</returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.ConvertTextToSlug(System.String)">
+ <summary>
+ Creates a "slug" from text that can be used as part of a valid URL.
+ Invalid characters are converted to hyphens. Punctuation that Is
+ perfect valid in a URL Is also converted to hyphens to keep the
+ result mostly text. Steps are taken to prevent leading, trailing,
+ And consecutive hyphens.
+ </summary>
+ <param name="s">The string to convert</param>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.RemoveInvalidCharacters(System.String)">
+ <summary>
+ Removes Invalid characters from a string, suitable for file and path names
+ 
+ Removed characters are:
+ 
+ * Illegal File-characters
+ * Illegal Path-characters
+ * Unicode characters that classify as Emoji
+ * All characters above codepoint U+10000
+ 
+ See: 
+ https://stackoverflow.com/questions/46905176/detecting-all-emojis
+ https://stackoverflow.com/questions/28023682/how-do-i-remove-emoji-characters-from-a-string
+ </summary>
+ <returns></returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.TestContainsInvalidCharacters(System.String)">
+ <summary>
+ Checks if string contains invalid characters
+ </summary>
+ <param name="pString"></param>
+ <returns></returns>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.IsVisibleOnAnyScreen(System.Drawing.Point)">
+ <summary>
+ Checks if a point is Visible on any screen
+ </summary>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.SizeIsVisible(System.Drawing.Size)">
+ <summary>
+ Checks if Size is not negative
+ </summary>
+</member>
+<member name="M:DigitalData.Modules.Language.Utils.LocationIsVisible(System.Drawing.Point)">
+ <summary>
+ Checks if Location is not negative
+ </summary>
+</member>
+</members>
+</doc>

Language/bin/Debug/DigitalData.Modules.Logging.xml

@@ -0,0 +1,200 @@
+<?xml version="1.0"?>
+<doc>
+<assembly>
+<name>
+DigitalData.Modules.Logging
+</name>
+</assembly>
+<members>
+<member name="T:DigitalData.Modules.Logging.My.Resources.Resources">
+<summary>
+  Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
+</summary>
+</member>
+<member name="P:DigitalData.Modules.Logging.My.Resources.Resources.ResourceManager">
+<summary>
+  Gibt die zwischengespeicherte ResourceManager-Instanz zurück, die von dieser Klasse verwendet wird.
+</summary>
+</member>
+<member name="P:DigitalData.Modules.Logging.My.Resources.Resources.Culture">
+<summary>
+  Überschreibt die CurrentUICulture-Eigenschaft des aktuellen Threads für alle
+  Ressourcenzuordnungen, die diese stark typisierte Ressourcenklasse verwenden.
+</summary>
+</member>
+<member name="T:DigitalData.Modules.Logging.LogConfig">
+ <module>LogConfig</module>
+ <version>0.0.1.0</version>
+ <date>02.10.2018</date>
+ <summary>
+ Module that writes file-logs to different locations:
+ local application data, the current directory or a custom path.
+ Files and directories will be automatically created.
+ </summary>
+ <dependencies>
+ NLog, >= 4.5.8
+ </dependencies>
+ <example>
+ Imports DigitalData.Modules.Logging
+ 
+ Class FooProgram
+     Private Logger as Logger
+     Private LogConfig as LogConfig
+                 
+     Public Sub New()
+         LogConfig = new LogConfig(args)
+         Logger = LogConfig.GetLogger()
+     End Sub
+                     
+     Public Sub Bar()
+         Logger.Info("Baz")
+     End Sub
+ End Class
+                 
+ Class FooLib
+     Private Logger as NLog.Logger
+                 
+     Public Sub New(LogConfig as LogConfig)
+         Logger = LogConfig.GetLogger()
+     End Sub
+                     
+     Public Sub Bar()
+         Logger.Info("Baz")
+     End Sub
+ End Class
+ </example>
+ <remarks>
+ If logpath can not be written to, falls back to temp folder as defined in:
+ https://docs.microsoft.com/de-de/dotnet/api/system.io.path.gettemppath?view=netframework-4.7.2
+                 
+ If used in a service, LogPath must be set to CustomPath, otherwise the Log will be written to System32!
+                 
+ For NLog Troubleshooting, set the following Environment variables to write the NLog internal Log:               
+ - NLOG_INTERNAL_LOG_LEVEL: Debug
+ - NLOG_INTERNAL_LOG_FILE: ex. C:\Temp\Nlog_Internal.log
+ </remarks>
+</member>
+<member name="P:DigitalData.Modules.Logging.LogConfig.LogFactory">
+ <summary>
+ Returns the NLog.LogFactory object that is used to create Loggers
+ </summary>
+ <returns>LogFactory object</returns>
+</member>
+<member name="P:DigitalData.Modules.Logging.LogConfig.LogFile">
+ <summary>
+ Returns the path to the current default logfile
+ </summary>
+ <returns>Filepath to the logfile</returns>
+</member>
+<member name="P:DigitalData.Modules.Logging.LogConfig.LogDirectory">
+ <summary>
+ Returns the path to the current log directory
+ </summary>
+ <returns>Directory path to the log directory</returns>
+</member>
+<member name="P:DigitalData.Modules.Logging.LogConfig.Debug">
+ <summary>
+ Determines if a debug log will be written
+ </summary>
+ <returns>True, if debug log will be written. False otherwise.</returns>
+</member>
+<member name="P:DigitalData.Modules.Logging.LogConfig.Logs">
+ <summary>
+ Returns Logs in Memory as List(Of String) if Debug is enabled
+ Returns an empty list if debug is disabled
+ </summary>
+ <returns>A list of log messages</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogOptions)">
+ <summary>
+ Initializes a new LogConfig object with the options supplied as a LogOptions object
+ </summary>
+ <param name="Options"></param>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String,System.String,System.String,System.Int32)">
+ <summary>
+ Initializes a new LogConfig object with a logpath and optinally a filename-suffix.
+ </summary>
+ <param name="LogPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
+ <param name="CustomLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
+ <param name="Suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
+ <param name="CompanyName">CompanyName is used to construct log-path in when LogPath is set to PathType:AppData</param>
+ <param name="ProductName">ProductName is used to construct log-path in when LogPath is set to PathType:AppData</param>
+ <param name="FileKeepRangeInDays">Amount of days where files are kept and not deleted.</param>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.ClearOldLogfiles(System.Int32)">
+ <summary>
+ Clears old LogFiles from the configured logpath for compliance with the GDPR
+ </summary>
+ <param name="FileKeepRange">Days in which logfiles should be kept. All files older than `Now - FileKeepInterval` will be deleted.</param>
+ <returns>True, if files were deleted as expected or no files were deleted. Otherwise false.</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger">
+ <summary>
+ Returns the Logger for the calling class
+ </summary>
+ <returns>An object of Logging.Logger</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String)">
+ <summary>
+ Returns the Logger for the specified classname
+ </summary>
+ <returns>An object of Logging.Logger</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetLoggerFor(System.String)">
+ <summary>
+ Returns the Logger for the specified module using event-properties
+ </summary>
+ <remarks>
+ https://github.com/NLog/NLog/wiki/EventProperties-Layout-Renderer
+ https://stackoverflow.com/questions/31337030/separate-log-file-for-specific-class-instance-using-nlog/32065824#32065824
+ </remarks>
+ <returns>An object of Logging.Logger</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger(System.String,System.String)">
+ <summary>
+ Returns the Logger for a class specified by `ClassName`
+ </summary>
+ <param name="ClassName">The name of the class the logger belongs to</param>
+ <returns>An object of Logging.Logger</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.ClearLogs">
+ <summary>
+ Clears the internal log
+ </summary>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetClassFullName(System.Boolean,System.Int32)">
+ <summary>
+ Gets the fully qualified name of the class invoking the calling method,
+ including the namespace but Not the assembly.  
+ </summary>
+ <returns>The fully qualified class name</returns>
+ <remarks>This method is very resource-intensive!</remarks>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetConfig(System.String,System.String)">
+ <summary>
+ Returns the initial log configuration
+ </summary>
+ <param name="productName">The chosen productname</param>
+ <param name="logFileSuffix">The chosen suffix</param>
+ <returns>A NLog.LoggingConfiguration object</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.AddDefaultRules(NLog.Config.LoggingConfiguration@)">
+ <summary>
+ Adds the default rules 
+ </summary>
+ <param name="config">A NLog.LoggingConfiguration object</param>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.GetCurrentLogFilePath">
+ <summary>
+ Returns the full path of the current default log file.
+ </summary>
+ <returns>Full path of the current default log file</returns>
+</member>
+<member name="M:DigitalData.Modules.Logging.LogConfig.ReloadConfig">
+ <summary>
+ Reconfigures and re-adds all loggers, optionally adding the debug rule.
+ </summary>
+</member>
+</members>
+</doc>