362 lines
14 KiB
XML
362 lines
14 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>
|
|
DigitalData.Modules.Base
|
|
</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:DigitalData.Modules.Base.My.Resources.Resources">
|
|
<summary>
|
|
Eine stark typisierte Ressourcenklasse zum Suchen von lokalisierten Zeichenfolgen usw.
|
|
</summary>
|
|
</member>
|
|
<member name="P:DigitalData.Modules.Base.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.Base.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.Base.BaseClass">
|
|
<summary>
|
|
BaseClass that sets up a Logger.
|
|
</summary>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.Encryption">
|
|
<summary>
|
|
https://stackoverflow.com/questions/10168240/encrypting-decrypting-a-string-in-c-sharp
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.DatabaseEx.NotNull``1(System.Data.DataRow,System.String,``0)">
|
|
<summary>
|
|
TODO: Deprecate
|
|
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="pRow">The DataRow that contains the value</param>
|
|
<param name="pColumn">The column name</param>
|
|
<param name="pDefaultValue">The default value</param>
|
|
<returns>The original value or the default value</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetChecksum(System.String)">
|
|
<summary>
|
|
Reads the file at `FilePath` and computes a SHA256 Hash from its contents
|
|
</summary>
|
|
<param name="FilePath"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedFilename(System.String)">
|
|
<summary>
|
|
Adds file version string to given filename `Destination` if that file already exists.
|
|
</summary>
|
|
<param name="pFilePath">Filepath to check</param>
|
|
<returns>Versioned string</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedFilenameWithFilecheck(System.String,System.Func{System.String,System.Boolean})">
|
|
<summary>
|
|
Adds file version string to given filename `Destination` if that file already exists.
|
|
</summary>
|
|
<param name="pFilePath">Filepath to check</param>
|
|
<param name="pFileExistsAction">Custom action to check for file existence</param>
|
|
<returns>Versioned string</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.GetVersionedString(System.String)">
|
|
<summary>
|
|
Split String at version separator to:
|
|
check if string is already versioned,
|
|
get the string version of an already versioned string
|
|
</summary>
|
|
<example>
|
|
Examples:
|
|
test1.pdf --> test1 --> ['test1'] --> no fileversion
|
|
test1~2.pdf --> test1~2 --> ['test1', '2'] --> version 2
|
|
test1~12345~2.pdf --> test1~12345~2 --> ['test1', '12345', '2'] --> still version 2
|
|
somestring~3 --> somestring~3 --> ['somestring', '3'] --> version 3
|
|
</example>
|
|
<param name="pString">The string to versioned</param>
|
|
<returns>Tuple of string and version</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.RemoveFiles(System.String,System.Int32,System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Removes files in a directory filtered by filename, extension and last write date
|
|
</summary>
|
|
<param name="Path">The directory in which files will be deleted</param>
|
|
<param name="FileKeepTime">Only delete files which are older than x days. Must be between 0 and 1000 days.</param>
|
|
<param name="FileBaseName">A filename filter which will be checked</param>
|
|
<param name="FileExtension">A file extension which will be checked</param>
|
|
<param name="ContinueOnError">Should the function continue with deleting when a file could not be deleted?</param>
|
|
<returns>True if all files were deleted or if no files were deleted, otherwise false</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.CopyDirectory(System.String,System.String,System.Boolean)">
|
|
<summary>
|
|
Copied from https://docs.microsoft.com/en-us/dotnet/standard/io/how-to-copy-directories
|
|
</summary>
|
|
<param name="SourceDirName"></param>
|
|
<param name="DestDirName"></param>
|
|
<param name="CopySubDirs"></param>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.CreateDirectory(System.String,System.Boolean)">
|
|
<summary>
|
|
Tries to create a directory and returns its path.
|
|
Returns a temp path if `DirectoryPath` can not be created or written to.
|
|
</summary>
|
|
<param name="DirectoryPath">The directory to create</param>
|
|
<param name="TestWriteAccess">Should a write access test be performed?</param>
|
|
<returns>The used path</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.TestFileIsLocked(System.String)">
|
|
<summary>
|
|
Checks if a file is locked, ie. in use by another process.
|
|
</summary>
|
|
<remarks>
|
|
https://docs.microsoft.com/en-us/dotnet/standard/io/handling-io-errors
|
|
https://stackoverflow.com/questions/876473/is-there-a-way-to-check-if-a-file-is-in-use
|
|
</remarks>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FilesystemEx.TestFileSizeIsLessThanMaxFileSize(System.String,System.Int32)">
|
|
<summary>
|
|
Checks the size of the supplied file.
|
|
</summary>
|
|
<param name="pFilePath"></param>
|
|
<param name="pMaxFileSizeInMegaBytes"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileWatcher.HandleFileChanged(System.Object,System.IO.FileSystemEventArgs)">
|
|
<summary>
|
|
This may fire twice for a single save operation,
|
|
see: https://blogs.msdn.microsoft.com/oldnewthing/20140507-00/?p=1053/
|
|
</summary>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.FileWatcherFilters">
|
|
<summary>
|
|
Built-in filters for FileWatcher that are useful for correctly detecting changes on Office documents (currently Office 2016)
|
|
</summary>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.FileWatcherFilters.BaseFileFilter">
|
|
<summary>
|
|
Base Filter that all filters must inherit from
|
|
Provides two functions that may be overridden and some useful file extension lists
|
|
</summary>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.FileWatcherFilters.TempFileFilter">
|
|
<summary>
|
|
Simple Filter that filters changes made on temporary files
|
|
</summary>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.FileWatcherFilters.OfficeFileFilter">
|
|
<summary>
|
|
Filter to detect changes on Office files
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ModuleExtensions.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.Base.ModuleExtensions.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="M:DigitalData.Modules.Base.ModuleExtensions.ToBoolean(System.String)">
|
|
<summary>
|
|
Converts a string to boolean. Accepts true and 1 as truthy values
|
|
</summary>
|
|
<param name="pString">The input string</param>
|
|
<returns>True if input is true or 1, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNullOrEmpty(System.String)">
|
|
<summary>
|
|
Checks if a string is null or empty
|
|
</summary>
|
|
<param name="pString">The input string</param>
|
|
<returns>True string is null or empty, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ModuleExtensions.IsNotNullOrEmpty(System.String)">
|
|
<summary>
|
|
Checks if a string is NOT null or empty
|
|
</summary>
|
|
<param name="pString">The input string</param>
|
|
<returns>True string is null or empty, otherwise false.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileEx.GetChecksumFromFileContents(System.String)">
|
|
<summary>
|
|
Reads the file at `FilePath` and computes a SHA256 Hash from its contents
|
|
</summary>
|
|
<param name="pFilePath"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String,System.DateTime)">
|
|
<summary>
|
|
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day]
|
|
</summary>
|
|
<param name="pBaseDirectory">The basedirectory</param>
|
|
<param name="pDate">The date to be used</param>
|
|
<returns>The final directory path</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileEx.GetDateDirectory(System.String)">
|
|
<summary>
|
|
Returns a Dictionary path in the form of [Base]\[Year]\[Month]\[Day] based on the current date
|
|
</summary>
|
|
<param name="pBaseDirectory">The basedirectory</param>
|
|
<returns>The final directory path</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String,System.DateTime)">
|
|
<summary>
|
|
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day]
|
|
</summary>
|
|
<param name="pBaseDirectory">The basedirectory</param>
|
|
<param name="pDate">The date to be used</param>
|
|
<returns>The created path. If the directory cannot be created, Nothing.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.FileEx.CreateDateDirectory(System.String)">
|
|
<summary>
|
|
Creates a Dictionary in the form of [Base]\[Year]\[Month]\[Day] based on the current date
|
|
</summary>
|
|
<param name="pBaseDirectory">The basedirectory</param>
|
|
<returns>The created path. If the directory cannot be created, Nothing.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ObjectEx.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.Base.ObjectEx.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.Base.ObjectEx.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.Base.ObjectEx.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.Base.GraphicsEx.GetBrightness(System.Drawing.Color)">
|
|
<summary>
|
|
Returns the brightness of a color as a number between 0 and 1
|
|
</summary>
|
|
<param name="pColor">The color to check</param>
|
|
<returns>Low values for dark colors, high values for bright colors.</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.GraphicsEx.GetContrastedColor(System.Drawing.Color)">
|
|
<summary>
|
|
Returns a foreground/text color of either black or white, depending on the brightness of `pOtherColor`
|
|
</summary>
|
|
<param name="pOtherColor">The Background color whose brightness is determined</param>
|
|
<returns>A text color which is either white or black</returns>
|
|
</member>
|
|
<member name="T:DigitalData.Modules.Base.LanguageEx">
|
|
<summary>
|
|
Functions relating to i18n, Cultures, Translations
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.LanguageEx.SetApplicationLanguage(DigitalData.Modules.Logging.Logger,System.String,System.String)">
|
|
<summary>
|
|
Sets the Language of the current thread by setting CurrentCulture and CurrentUICulture
|
|
</summary>
|
|
<param name="pLogger">A Logger instance</param>
|
|
<param name="pUserLanguage">A language code in the form of 'de-DE'</param>
|
|
<param name="pUserDateFormat">A custom date pattern</param>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.LanguageEx.LogApplicationLanguage(DigitalData.Modules.Logging.Logger)">
|
|
<summary>
|
|
Logs the culture settings of the current thread
|
|
</summary>
|
|
<param name="pLogger">A Logger instance</param>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ScreenEx.IsVisibleOnAnyScreen(System.Drawing.Point)">
|
|
<summary>
|
|
Checks if a point is Visible on any screen
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ScreenEx.SizeIsVisible(System.Drawing.Size)">
|
|
<summary>
|
|
Checks if Size is not negative
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.ScreenEx.LocationIsVisible(System.Drawing.Point)">
|
|
<summary>
|
|
Checks if Location is not negative
|
|
</summary>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.StringEx.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.Base.StringEx.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.Base.StringEx.GetShortGUID">
|
|
<summary>
|
|
Generates a random short (8 characters) guid
|
|
</summary>
|
|
<returns>The generated guid as a String</returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.StringEx.TestContainsInvalidCharacters(System.String)">
|
|
<summary>
|
|
Checks if string contains invalid characters
|
|
</summary>
|
|
<param name="pString"></param>
|
|
<returns></returns>
|
|
</member>
|
|
<member name="M:DigitalData.Modules.Base.StringEx.GetChecksum(System.String)">
|
|
<summary>
|
|
Creates a hash using the SHA256 algorithm and returns it
|
|
</summary>
|
|
<param name="pStringToCheck">Any string</param>
|
|
<returns></returns>
|
|
</member>
|
|
</members>
|
|
</doc>
|