Westwind.Utilities

This class provides a base class for code-first, strongly typed configuration settings in .NET. It supports storing of configuration data in .NET .config files, plain XML files, strings and SQL Server databases and custom providers. Using this class is easy: Create a subclass of AppConfiguration and then simply add properties to the class. Then instantiate the class, call Initialize(), then simply access the class properties to read configuration values. The default implementation uses standard .NET configuration files and a custom section within that file to hold configuration values. Other providers can be used to store data to different stores and you can create your own custom providers to store configuration data in yet other stores. Managing Configuration Settings with AppConfiguration

An instance of a IConfigurationProvider that needs to be passed in via constructor or set explicitly to read and write from the configuration store.

Contains an error message if a method returns false or the object fails to load the configuration data. Class AppConfiguration

Internal flag that checks to see if Initialize was called if not - automatically calls it without parameters

Default constructor of this class SHOULD ALWAYS be implemented in every subclass to allow serialization instantiation and setting of initial property values.

This method initializes the configuration object with a provider and performs an initial read from the config store.

Optional - preconfigured ConfigurationProvider instance. If not passed ConfigurationFileConfigurationProvider is used. Optional - sub-section name used for config files. Not used by all config stores Optional - additional config data to pass to OnInitialize if implemented

Override this method to handle custom initialization tasks. This method should: create a provider and call it's Read() method to populate the current instance of the configuration object. If all you need is to create a default provider configuration use the OnCreateDefaultProvider() method to override instead. Use this method if you need to perform custom actions beyond provider instantiation.

Provider value - can be null in which case ConfigurationFileProvider is used Sub Section name - can be null. Classname is used if null. Can be "appSettings" Any additional configuration data that can be used to configure the provider.

Override this method to use a specialized configuration provider for your config class when no explicit provider is passed to the Initialize() method.

Optional section name that was passed to Initialize() Optional config data that was passed to Initialize() Instance of configuration provider

Writes the current configuration information data to the provider's configuration store.

Writes the current configuration information to an XML string. String is in .NET XML Serialization format.

Reads the configuration information from the provider's store and returns a new instance of an configuration object.

This configuration class type

Reads the configuration from the provider's store into the current object instance.

Reads configuration data from a string and populates the current instance with the values. Data should be serialized in XML Searlization format created with

Xml string in XML Serialization format true or false

Reads configuration based on a provider configuration and returns a new instance of the configuration object

A configured " provider instance of configuration or null on failure

Creates a new instance of the config object and retrieves configuration information from the provided string. String should be in XML Serialization format or created by the method.

Required if encryption decryption is desired config instance or null on failure

Creates a new instance of the config object and retrieves configuration information from the provided string. String should be in XML Serialization format or created by the method.

config instance or null on failure

Sample class for diagram display

Optional - the Configuration file where configuration settings are stored in. If not specified uses the default Configuration Manager and its default store.

internal property used to ensure there are no multiple write operations at the same time

Internally used reference to the Namespace Manager object used to make sure we're searching the proper Namespace for the appSettings section when reading and writing manually

Reads configuration settings into a new instance of the configuration object.

Reads configuration settings from the current configuration manager. Uses the internal APIs to write these values.

Reads Configuration settings from an external file or explicitly from a file. Uses XML DOM to read values instead of using the native APIs.

Configuration instance Filename to read from

Returns a single value from the XML in a configuration file.

Used to load up the default namespace reference and prefix information. This is required so that SelectSingleNode can find info in 2.0 or later config files that include a namespace on the root element definition.

Creates a Configuration section and also creates a ConfigSections section for new non appSettings sections.

Converts a type to string if possible. This method supports an optional culture generically on any value. It calls the ToString() method on common types and uses a type converter on all other objects if available

The Value or Object to convert to a string Culture for numeric and DateTime values Return string for unsupported types string

Turns a string into a typed value generically. Explicitly assigns common types and falls back on using type converters for unhandled types. Common uses: * UI -> to data conversions * Parsers Class ReflectionUtils

The string to convert from The type to convert to Culture used for numeric and datetime values. object. Throws exception if it cannot be converted.

Base Configuration Provider Implementation. This implementation provides for the basic layout of a provider and fields that implement the IConfigurationProvider interface. The Read and Write methods must be overridden - all other methods and fields are optional

Displays error information when results fail.

A comma delimiter list of property names that are to be encrypted when persisted to the store

The encryption key to encrypt the fields set with FieldsToEncrypt

Optional Section name that can differentiate groups of config values in multi-section files like Config files.

Reads a configurations settings from the configuration store into a new existing instance.

Specific Config Settings Class

Reads configuration settings from the store into a passed instance of the configuration instance.

Specific config settings class instance true or false

Writes the configuration settings from a specific instance into the configuration store.

Creates a new instance of the application object and retrieves configuration information from the provided string. String should be in XML Serialization format or created by the WriteAsString method.

Type of the specific configuration class An xml string that contains XML Serialized serialization data The deserialized instance or null on failure

Reads data into configuration from an XML string into a passed instance of the a configuration object.

An instance of a custom configuration object Xml of serialized configuration instance. true or false

Writes the current configuration information to an XML string. String is XML Serialization format.

xml string of serialized config object

Encrypts all the fields in the current object based on the EncryptFieldList

Internally decryptes all the fields in the current object based on the EncryptFieldList

Sets an error message when an error occurs

Writes an exception and innerexception message into the error message text

Helper method to create a new instance of the Configuration object.

Configuration Provider interface that provides read and write services to various configuration storage mechanisms. Used in conjunction with the class. A base implementation from which to inherit is provided in the class.

Holds an error message after a read or write operation failed.

A comma delimited list of fields that are to be encrypted

The encryption key used to encrypt fields in config objects

Optional Section name that can be used to sub-segment in multi-config files

Reads configuration information into new configuration object instance

Reads configuration information into a provided config object instance

Reads configuration information from an XML string (Xml Serialization format) into a provided config object instance

Writes configuration information into a provided object instance

Writes configuration for a provided config object and returns the serialized data as a string.

Encrypts fields in a config object as specified in the cref="PropertiesToEncrypt" property.

Decryptes the encyrpted fields in a config object a

Optional - the Configuration file where configuration settings are stored in. If not specified uses the default Configuration Manager and its default store.

Return

Write configuration to XmlConfigurationFile location

Reads and Writes configuration settings in .NET config files and sections. Allows reading and writing to default or external files and specification of the configuration section that settings are applied to. This implementation doesn't support Read and Write operation that don't return a string value. Only Read(string) and WriteAsString() should be used to read and write string values.

The raw SQL connection string or connectionstrings name for the database connection.

The data provider used to access the database

Table in the database that holds configuration data Table must have ID(int) and ConfigData (nText) fields

The key of the record into which the config data is written. Defaults to 1. If you need to read or write multiple different configuration records you have to change it on this provider before calling the Read()/Write() methods.

Reads configuration data into a new instance from SQL Server that is returned.

Reads configuration data from Sql Server into an existing instance updating its fields.

Reads and Writes configuration settings from strings - which you manage yourself. Using strings for the configuration provider allows for easy storage into any non-supported configuration stores that you control through your code as long as it supports strings. The string provider is a real minimal implementation that only implements WriteAsString(config) and Read(string). It inherits all of its functionality from the base provider.

Reads from the InitialStringData string data

Reads configuration information into config from InitialStringData

Not supported for StringConfiguration

Optional - the Configuration file where configuration settings are stored in. If not specified uses the default Configuration Manager and its default store.

Return

Write configuration to XmlConfigurationFile location

Used to parse a connection string or connection string name into a the base connection string and dbProvider. If a connection string is passed that's just used. If a ConnectionString entry name is passed the connection string is extracted and the provider parsed.

The default connection string provider

The connection string parsed

The DbProviderFactory parsed from the connection string or default provider

Figures out the Provider and ConnectionString from either a connection string name in a config file or full ConnectionString and provider.

Config file connection name or full connection string optional provider name. If not passed with a connection string is considered Sql Server optional provider factory. Use for .NET Core to pass actual provider instance since DbproviderFactories doesn't exist

Retrieves a connection string from the Connection Strings configuration settings

Throws when connection string doesn't exist

Base Data Access Layer (DAL) for ADO.NET SQL operations. Provides easy, single method operations to retrieve DataReader, DataTable, DataSet and Entities, perform non-query operations, call stored procedures. This abstract class implements most data operations using a configured DbProvider. Subclasses implement specific database providers and override a few methods that might have provider specific SQL Syntax.

Default constructor that should be called back to by subclasses. Parameterless assumes default provider and no connection string which must be explicitly set.

Most common constructor that expects a connection string or connection string name from a .config file. If a connection string is provided the default provider is used.

Constructor that expects a full connection string and provider for creating a SQL instance. To be called by the same implementation on a subclass.

Figures out the dbProvider and Connection string from a connectionString name in a config file or explicit ConnectionString and provider.

Config file connection name or full connection string optional provider name. If not passed with a connection string is considered Sql Server

The internally used dbProvider

An error message if a method fails

Optional error number returned by failed SQL commands

The prefix used by the provider

Determines whether parameters are positional or named. Positional parameters are added without adding the name using just the ParameterPrefix

Character used for the left bracket on field names. Can be empty or null to use none

Character used for the right bracket on field names. Can be empty or null to use none

ConnectionString for the data access component

A SQL Transaction object that may be active. You can also set this object explcitly

The SQL Connection object used for connections

The Sql Command execution Timeout in seconds. Set to -1 for whatever the system default is. Set to 0 to never timeout (not recommended).

Determines whether extended schema information is returned for queries from the server. Useful if schema needs to be returned as part of DataSet XML creation

Holds the last SQL string executed

Opens a Sql Connection based on the connection string. Called internally but externally accessible. Sets the internal _Connection property.

Closes a connection

Closes an active connection. If a transaction is pending the connection is held open.

Creates a Command object and opens a connection

Sql string to execute Either values mapping to @0,@1,@2 etc. or DbParameter objects created with CreateParameter() Command object or null on error

Creates a Command object and opens a connection

Sql string to execute Either values mapping to @0,@1,@2 etc. or DbParameter objects created with CreateParameter() command object

Adds parameters to a DbCommand instance. Parses value and DbParameter parameters properly into the command's Parameters collection.

A preconfigured DbCommand object that should have all connection information set DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Used to create named parameters to pass to commands or the various methods of this class.

Starts a new transaction on this connection/instance

Opens a Connection and keeps it open for the duration of the transaction. Calls to `.CloseConnection` while the transaction is active have no effect.

Commits all changes to the database and ends the transaction

Closes Connection

Rolls back a transaction

Closes Connection

Executes a non-query command and returns the affected records

Command should be created with GetSqlCommand to have open connection Affected Record count or -1 on error

Executes a command that doesn't return any data. The result returns the number of records affected or -1 on error.

SQL statement as a string DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a command that doesn't return a data result. You can return output parameters and you do receive an AffectedRecords counter. .setItem("list_html", JSON.stringify(data));

Executes a non-query command and returns the affected records

Command should be created with GetSqlCommand to have open connection Affected Record count or -1 on error

Executes a command that doesn't return any data. The result returns the number of records affected or -1 on error.

SQL statement as a string DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a command that doesn't return a data result. You can return output parameters and you do receive an AffectedRecords counter. .setItem("list_html", JSON.stringify(data));

Executes a command and returns a scalar value from it

DbCommand containing command to run DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values value or null on failure

Executes a Sql command and returns a single value from it.

Sql string to execute DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values Result value or null. Check ErrorMessage on Null if unexpected

Executes a command and returns a scalar value from it

DbCommand containing command to run DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values value or null on failure

Executes a Sql command and returns a single value from it.

Sql string to execute DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values Result value or null. Check ErrorMessage on Null if unexpected

Executes a long SQL script that contains batches (GO commands). This code breaks the script into individual commands and captures all execution errors. If ContinueOnError is false, operations are run inside of a transaction and changes are rolled back. If true commands are accepted even if failures occur and are not rolled back.

Executes a SQL Command object and returns a SqlDataReader object

Command should be created with GetSqlCommand and open connection A SqlDataReader. Make sure to call Close() to close the underlying connection.

Executes a SQL command against the server and returns a DbDataReader

Sql String DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a Sql statement and returns a dynamic DataReader instance that exposes each field as a property

Sql String to executeTable DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Return a list of entities that are matched to an object

Type of object to create from data record Sql string DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values An enumerated list of objects or null

Allows querying and return a list of entities.

DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a SQL statement and creates an object list using optimized Reflection. Not very efficient but provides an easy way to retrieve an object list from query.

Entity type to create from DataReader data Sql string to execute DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values List of objects or null. Null is returned if there are no matches

Returns list of objects from a query.

Sql Statement string Comma delimited list of property names to skip DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a SQL command and creates an object list using Reflection. Not very efficient but provides an easy way to retrieve object lists from queries.

Entity type to create from DataReader data Command object containing configured SQL command to execute DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values List of objects or null. Null is returned if there are no matches

Executes a SQL statement and creates an object list using Reflection. Not very efficient but provides an easy way to retrieve object lists from queries

Entity type to create from DataReader data Sql string to execute Comma delimited list of properties that are not to be updated DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values List of objects

Executes a SQL statement and creates an object list using Reflection. Not very efficient but provides an easy way to retrieve

Entity type to create from DataReader data Sql string to execute DbParameters to fill the SQL statement List of objects

Calls a stored procedure that returns a cursor results The result is returned as a DataReader

Name of the Stored Procedure to call Parameters to pass. Note that if you need to pass out/inout/return parameters you need to pass DbParameter instances or use the CreateParameter() method A DataReader or null on failure

Calls a stored procedure that returns a cursor results The result is returned as an IEnumerable<T>> list

IEnumerable<Customer%gt; customers = context.Db.ExecuteStoredProcedureReader<Customer>('GetCustomers', context.Db.CreateParameter('@cCompany','W%')); Name of the Stored Procedure to call Use CreateParameter() for named, output or return parameters. Plain values for others. A DataReader or null on failure

Executes a stored procedure that doesn't return a result set.

The Stored Procedure to call Parameters to pass. Note that if you need to pass out/inout/return parameters you need to pass DbParameter instances or use the CreateParameter() method > 0 or greater on success, -1 on failure

Returns a DataTable from a Sql Command string passed in.

DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Returns a DataTable from a Sql Command string passed in.

DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Returns a DataSet/DataTable from a Sql Command string passed in.

The name for the table generated or the base names DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Executes a SQL command against the server and returns a DataSet of the result

DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Returns a DataSet from a Sql Command string passed in.

Returns a DataTable from a Sql Command string passed in.

Sql 2005 specific semi-generic paging routine

Generic routine to retrieve an object from a database record The object properties must match the database fields.

The object to update Database command object

Retrieves a single record and returns it as an entity

DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Generic routine to return an Entity that matches the field names of a table exactly.

Returns a single entity based on a keyfield and key value

Type of entity to populate Value to look up in keyfield Name of the table to work on Field that is used for the key lookup

Returns the first matching record retrieved from data based on a SQL statement as an entity or null if no match was found.

Entity type to fill SQL string to execute. Use @0,@1,@2 for parameters. Recommend you use `TOP1` in your SQL statements to limit the amount of data returned from the underlying query even though a full list returns the same result. DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Returns an entity that is the first match from a sql statement string.

Entity type to return Sql string to execute. Use @0,@1,@2 for positional parameters fields to not update from the resultset DbParameters (CreateParameter()) for named parameters or use @0,@1 parms in SQL and plain values

Updates an entity object that has matching fields in the database for each public property. Kind of a poor man's quick entity update mechanism. Note this method will not save if the record doesn't already exist in the db.

entity to update the table name to update keyfield used to find entity

This version of UpdateEntity allows you to specify which fields to update and so is a bit more efficient as it only checks for specific fields in the database and the underlying table.

Entity to update DB Table to udpate The keyfield to query on fields to skip in update fields that should be updated

Gets a DbCommand that creates an update statement. that allows you to specify which fields to update and so is a bit more efficient as it only checks for specific fields in the database and the underlying table.

Entity to update DB Table to udpate The keyfield to query on fields to skip in update fields that should be updated

Inserts an object into the database based on its type information. The properties must match the database structure and you can skip over fields in the propertiesToSkip list.

Scope Identity or Null (when returnIdentityKey is true Otherwise affected records

Inserts an object into the database based on its type information. The properties must match the database structure and you can skip over fields in the propertiesToSkip list.

Scope Identity or Null (when returnIdentityKey is true Otherwise affected records

Gets the DbCommand used to insert an object into the database based on its type information. The properties must match the database structure and you can skip over fields in the propertiesToSkip list.

Scope Identity or Null (when returnIdentityKey is true Otherwise affected records

Saves an enity into the database using insert or update as required. Requires a keyfield that exists on both the entity and the database.

entity to save table to save to keyfield to update optional fields to skip when updating (keys related items etc)

Sets the error message for the failure operations

Sets the error message and error number.

Sets the error message for failure operations.

Sql Server specific implementation of the DataAccessBase class to provide an easy to use Data Access Layer (DAL) with single line operations for most data retrieval and non-query operations.

Sql 2005 and later specific semi-generic paging routine

Extends the DataTable to provide access to DynamicDataRow data.

Returns a dynamic DataRow instance that can be accessed with the field name as a property

taTab

Returns a dynamic list of rows so you can reference them with row.fieldName

Helper class that extends a DataRow collection to be exposed as individual objects

This class provides an easy way to use object.property syntax with a DataReader by wrapping a DataReader into a dynamic object. The class also automatically fixes up DbNull values (null into .NET and DbNUll)

Cached Instance of DataReader passed in

Pass in a loaded DataReader

DataReader instance to work off

Returns a value from the current DataReader record If the field doesn't exist null is returned. DbNull values are turned into .NET nulls.

This class provides an easy way to turn a DataRow into a Dynamic object that supports direct property access to the DataRow fields. The class also automatically fixes up DbNull values (null into .NET and DbNUll to DataRow)

Instance of object passed in

Pass in a DataRow to work off

Returns a value from a DataRow items array. If the field doesn't exist null is returned. DbNull values are turned into .NET nulls.

Property setter implementation tries to retrieve value from instance first then into this object

A collection of ValidationError objects that is used to collect errors that occur duing calls to the Validate method.

Indexer property for the collection that returns and sets an item

Adds a new error to the collection Class ValidationError

Validation Error object Void

Adds a new error to the collection Class ValidationErrorCollection

Message of the error optional field name that it applies to (used for Databinding errors on controls) An optional ID you assign the error Void

Like Add but allows specifying of a format

Removes the item specified in the index from the Error collection

Adds a validation error if the condition is true. Otherwise no item is added. Class ValidationErrorCollection

If true this error is added. Otherwise not. The message for this error Name of the UI field (optional) that this error relates to. Used optionally by the databinding classes. An optional Error ID. value of condition

Adds a validation error if the condition is true. Otherwise no item is added. Class ValidationErrorCollection

If true the Validation Error is added. The Error Message for this error. value of condition

Adds a validation error if the condition is true. Otherwise no item is added. Class ValidationErrorCollection

If true the Validation Error is added. The Error Message for this error. string

Asserts a business rule - if condition is true it's added otherwise not. Class ValidationErrorCollection

If this condition evaluates to true the Validation Error is added Validation Error Object value of condition

Returns a string representation of the errors in this collection. The string is separated by CR LF after each line.

Returns an HTML representation of the errors in this collection. The string is returned as an HTML unordered list.

Object that holds a single Validation Error for the business object

The error message for this validation error.

The name of the field that this error relates to.

An ID set for the Error. This ID can be used as a correlation between bus object and UI code.

An HTTP wrapper class that abstracts away the common needs for adding post keys and firing update events as data is received. This class is real easy to use with many common operations requiring single method calls. The class also provides automated cookie and state handling, GZip compression decompression, simplified proxy and authentication mechanisms to provide a simple single level class interface. The underlying WebRequest is also exposed so you will not loose any functionality from the .NET BCL class.

Determines how data is POSTed when when using AddPostKey() and other methods of posting data to the server. Support UrlEncoded, Multi-Part, XML and Raw modes.

User name used for Authentication. To use the currently logged in user when accessing an NTLM resource you can use "AUTOLOGIN".

Password for Authentication.

Address of the Proxy Server to be used. Use optional DEFAULTPROXY value to specify that you want to IE's Proxy Settings

Semicolon separated Address list of the servers the proxy is not used for.

Username for a password validating Proxy. Only used if the proxy info is set.

Password for a password validating Proxy. Only used if the proxy info is set.

Timeout for the Web request in seconds. Times out on connection, read and send operations. Default is 30 seconds.

Returns whether the last request was cancelled through one of the events.

Use this option to set a custom content type. If possible use PostMode to specify a predefined content type as it will ensure that Post data is appropriately formatted. If setting the content type manually POST data

When true will automatically add Accept-Encoding: gzip,deflate header and automatically decompress gzip and deflate content

Keeps track of request timings for the last executed request. Tracks started, firstbyte and lastbyte times as well as ms to first byte (actually first 'buffer' loaded) and last byte.

Does not work with DownloadStream() since you control the stream's operations.

Error Message if the Error Flag is set or an error value is returned from a method.

Error flag if an error occurred.

Determines whether errors cause exceptions to be thrown. By default errors are handled in the class and the Error property is set for error conditions. (not implemented at this time).

If set to true will automatically track cookies between multiple successive requests on this instance. Uses the CookieCollection property to persist cookie status. When set posts values in the CookieCollection, and on return fills the CookieCollection with cookies from the Response.

Holds the internal Cookie collection before or after a request. This collection is used only if HandleCookies is set to .t. which also causes it to capture cookies and repost them on the next request.

WebResponse object that is accessible after the request is complete and allows you to retrieve additional information about the completed request. The Response Stream is already closed after the GetUrl methods complete (except GetUrlResponse()) but you can access the Response object members and collections to retrieve more detailed information about the current request that completed.

WebRequest object that can be manipulated and set up for the request if you called . Note: This object must be recreated and reset for each request, since a request's life time is tied to a single request. This object is not used if you specify a URL on any of the GetUrl methods since this causes a default WebRequest to be created.

The buffersize used for the Send and Receive operations

Lets you specify the User Agent browser string that is sent to the server. This allows you to simulate a specific browser if necessary.

The HttpClient Default Constructor

Creates a new WebRequest instance that can be set prior to calling the various Get methods. You can then manipulate the WebRequest property, to custom configure the request. Instead of passing a URL you can then pass null. Note - You need a new Web Request for each and every request so you need to set this object for every call if you manually customize it.

The Url to access with this WebRequest Boolean

Resets the Post buffer by clearing out all existing content

Adds POST form variables to the request buffer. PostMode determines how parms are handled.

Key value or raw buffer depending on post type Value to store. Used only in key/value pair modes

Adds POST form variables to the request buffer. PostMode determines how parms are handled.

Key value or raw buffer depending on post type Value to store. Used only in key/value pair modes

Adds a fully self contained POST buffer to the request. Works for XML or previously encoded content.

String based full POST buffer

Adds a fully self contained POST buffer to the request. Works for XML or previously encoded content.

Byte array of a full POST buffer

Allows posting a file to the Web Server. Make sure that you set PostMode

Returns the contents of the post buffer. Useful for debugging

Return a the result from an HTTP Url into a StreamReader. Client code should call Close() on the returned object when done reading.

Url to retrieve.

Return a the result from an HTTP Url into a StreamReader. Client code should call Close() on the returned object when done reading.

Url to retrieve.

Return an HttpWebResponse object for a request. You can use the Response to read the result as needed. This is a low level method. Most of the other 'Get' methods call this method and process the results further.

Important: The Response object's Close() method must be called when you are done with the object. Url to retrieve. An HttpWebResponse Object

Sends the Postbuffer to the server

Returns the content of a URL as a string

The intermediate download buffer used A .NET Encoding scheme or null to attempt sniffing from Charset.

Returns the content of a URL as a string using a specified Encoding

Internal download buffer size used to hold data chunks. A .NET Encoding scheme or null to attempt sniffing from Charset.

Returns the content of a URL as a string using a specified Encoding

Internal download buffer size used to hold data chunks. A .NET Encoding scheme or null to attempt sniffing from Charset.

Returns a partial response from the URL by specifying only given number of bytes to retrieve. This can reduce network traffic and keep string formatting down if you are only interested a small port at the top of the page. Also returns full headers.

Retrieves URL into an Byte Array.

Fires the ReceiveData Event Url to read Size of the buffer for each read. 0 = 8192

Retrieves URL into an Byte Array.

Fires the ReceiveData Event Url to read Size of the buffer for each read. 0 = 8192

Writes the output from the URL request to a file firing events.

Url to fire Buffersize - how often to fire events File to write response to true or false

Writes the output from the URL request to a file firing events.

Url to fire Buffersize - how often to fire events File to write response to true or false

Sets the certificate policy. Note this is a global setting and affects the entire application. It's recommended you set this for the application and not on a per request basis.

Handles the Certificate check

Fires progress events when receiving data from the server

Fires progress events when using GetUrlEvents() to retrieve a URL.

Event arguments passed to the ReceiveData event handler on each block of data sent

Size of the cumulative bytes read in this request

The number of total bytes of this request

The number of reads that have occurred - how often has this event been called.

The current chunk of data being read

Flag set if the request is currently done.

Flag to specify that you want the current request to cancel. This is a write-only flag

Releases response and request data

Enumeration of the various HTTP POST modes supported by HttpClient

Internal object used to allow setting WebRequest.CertificatePolicy to not fail on Cert errors

SMTP Wrapper around System.Net.Email.SmtpClient. Provided here mainly to provide compatibility with existing wwSmtp code and to provide a slightly more user friendly front end interface on a single object.

Mail Server to send message through. Should be a domain name (mail.yourserver.net) or IP Address (211.123.123.123). You can also provide a port number as part of the string which will override the ServerPort (yourserver.net:211) Class wwSmtp

Port on the mail server to send through. Defaults to port 25.

Use Tls Security

Email address or addresses of the Recipient. Comma delimit multiple addresses. To have formatted names use "Rick Strahl" <rstrahl@west-wind.com>

Carbon Copy Recipients

Blind Copy Recipients

Email address of the sender

Display name of the sender (optional)

The ReplyTo address

Message Subject.

The body of the message.

Username to connect to the mail server.

Password to connect to the mail server.

Any attachments you'd like to send

List of attachment objects

The content type of the message. text/plain default or you can set to any other type like text/html

Character Encoding for the message.

The character Encoding used to write the stream out to disk Defaults to the default Locale used on the server.

The content type for the alternate

The user agent for the x-mailer

Determines the priority of the message

Determines whether a return receipt is sent

An optional file name that appends logging information for the TCP/IP messaging to the specified file.

Determines whether wwSMTP passes back errors as exceptions or whether it sets error properties. Right now only error properties work reliably.

An Error Message if the result is negative or Error is set to true;

Error Flag set when an error occurs.

Connection timeouts for the mail server in seconds. If this timeout is exceeded waiting for a connection or for receiving or sending data the request is aborted and fails.

SMTP headers for this email request

Event fired when sending of a message or multiple messages is complete and the connection is to be closed. This event occurs only once per connection as opposed to the MessageSendComplete event which fires after each message is sent regardless of the number of SendMessage operations.

Event fired when an error occurs during processing and before the connection is closed down.

Internal instance of SmtpClient that holds the 'connection' effectively.

Adds an Smtp header to this email request. Headers are always cleared after a message has been sent or failed.

Adds headers from a CR/LF separate string that has key:value header pairs defined.

Lets you load the actual SMTP client instance prior to use so you can manipulate the actual Smtp instance.

Starts a new SMTP session. Note this doesn't actually open a connection but just configures and sets up the SMTP session. The actual connection is opened only when a message is actually sent

Cleans up and closes the connection

Fully self contained mail sending method. Sends an email message by connecting and disconnecting from the email server.

true or false

Run mail sending operation on a separate thread and asynchronously Operation does not return any information about completion.

Sends an individual message. Allows sending several messages on the same SMTP session without having to reconnect each time. This version assigns default properties assigned from the main mail object and allows overriding only of recipients Call after Connect() has been called and call Close() to close the connection afterwards

Configures the message interface

Assigns mail addresses from a string or comma delimited string list. Facilitates

Strips out just the email address from a full email address that might contain a display name in the format of: "Web Monitor" <rstrahl@west-wind.com>

Full email address to parse. Note currently only < and > tags are recognized as message delimiters only the email address

Adds a new Alternate view to the request. Passed from FoxPro which sets up this object.

Logs a message to the specified LogFile

Internally used to set errors

Delegate used to handle Completion and failure events

ConnectionString or other string that identifies the output medium

The name of the log file if a file is involved

Writes an entry into the log

Retireves an individual entry from the log

Retrieves a filtered list of entries

Returns a filtered list of entries as a strongly typed list

Creates the a standard Log store if it doesn't exist

Deletes the log file completely

Clears the Log store completely

Clears the log but leaves the last entries intact

Clears the log by a number of days

Returns a count of total log entries

Message object that contains information about the current error information Note: a WebLogEntry specific to Web applications lives in the Westwind.Web assembly.

The unique ID for this LogEntry

When this error occurred.

The Actual Error Message

Determines the error level of the messages

Free form text field that contains extra data to display

The type of exception that was thrown if an error occurred

StackTrace in event of an exception

Updates the current request as an error log entry and sets the ErrorType, Message and StackTrace properties from the content of the passed exception

A critical error occurred

A warning type message that drives attention to potential problems

Log Entry

Debug message

Application level information log entries

Application Level Error entries

Empty - not assigned

All ErrorLevels - used only for querying

The LogManager provides the top level access to the log and is the public facing interface to the log. It uses an underlying ILogProvider implementation to write to the appropriate log store. which includes Sql Server, Text File, Xml File or EventLog (and can be extended with your own providers) To use you'll need to create an instance of the LogProvider once can call the static Create method. From then on in you can always use the LogManager.Current instance to access features of the logging engine. To set up (Application_Start // Specify Sql Log with a Connection string or ConnectionString Config Entry Name LogManager.Create( new SqlLogAdapter("WestWindAdmin") ); To access log features: LogEntry entry = new LogEntry(); entry.Message = "Application started..."; entry.ErrorLevel =

Creates an instance of a log Manager and attaches it to the static Current property that is reusable throughout the application. This method should be called once when the application starts

Creates an instance of the LogManager based on the settings configured in the web.config file

Creates a new instance of the LogManager based on the settings in the .config file.

Static instance of the log manager. Used so you can configure the log manager once and easily reuse it in an application

Global instance of the LogAdapter used

Don't allow no-parm

Main signature allows creating of manager with an adapter to specify logging target Available Adapters are: SqlLogAdapter XmlLogAdapter (n/a) TextLogAdapter (n/a) EventLogAdapter (n/a)

Writes a Web specific log entry into the log

Writes an Info entry into the log

Writes an Error message entry to the log

Writes an error entry from an exception to the log

Writes a warning message to the log

Retrieves an individual log entry if possible. Depending on the implementation of the log log entries may not be retrievable individually (for example from a text log) or the event log.

Web Log Entry or null Fired if id is not found or data can't be accessed

Creates a new Log table/file/log depending on the provider. Check provider documentation on requirements for 'connections' or locations for logs.

Deletes the Log completely by removing the table/file/log

Clears out all the entries in the log

Clears the log but leaves specified number of the last entries

Returns count of all entries for a given error level.

Holds persisted Configuration Management settings that are maintained in the .config file

Initialize the LogManagerConfiguration by reading from configuration section "LogManager"

Static singleton instance of the configuration object that is always accessible

The 'connection string' for the LogManager. Can be a ConnectionStrings entry or a full connection string

The name of the file or table that holds log data. For SQL this will be a tablename. For Xml this is a virtual path for the xml log file (~/admin/ApplicationWebLog.xml) In non-web apps a full OS path should be used.

Determines what type of log is logged to

Determines whether Web Requests are logged. This property doesn't actually do anything in the log provider itself, but acts as a configuration setting placeholder that can be used in an application to determine whether you should log each request in a Web application

Determines whether Errors are logged. This property doesn't actually do anything in the log provider itself, but acts as a configuration setting placeholder that can be used in an application to determine whether you should log Errors

Determines what type of log output is created

Log adapter that writes to a SQL Server Database

The name of the table that data in SQL Server is written to

Must pass in a SQL Server connection string or config ConnectionString Id.

this version configures itself from the LogManager configuration section

Internally creates and configures an instance of the DAL used for data access

Writes a new Web specific entry into the log file Assumes that your log file is set up to be a Web Log file

Thrown if the insert operation fails

Returns an individual Web log entry from the log table

Returns entries for a given error level, and date range

Creates a new log table in the current database. If the table exists already it is dropped and recreated. Requires database admin access.

Deletes the Sql Log Table

Clears all the records of the log table

Clears the table and leaves the last number of records specified intact

Returns the number of total log entries

A Web specific Log entry that includes information about the current Web Request

The Url without the query string for the current request

The query string of the current request

The IP Address of the client that called this URL

The POST data if available

The Referring url

Optional duration of the current request

Updates the Web specific properties of this entry from the supplied HttpContext object.

The Xml Connection string is the filename

The name of the file where we're logging to

Writes an entry to the log

Returns an individual entry entity

Returns a filtered list of XML entries sorted in descending order.

The specific error level to return Max number of items to return From Date To Date "*" or any of the fields you want returned - currently not supported

Not implemented yet

Does nothing for the XmlLogAdapter - log is created with first new entry instead

Deletes the XML log file

Clears out all items from the XML log - in effect deletes the log file.

Not Implemented

Not implemented

Creates a DataTable on the fly

Updates the DataRow with data from node passed in

A strongly-typed resource class, for looking up localized strings, etc.

Returns the cached ResourceManager instance used by this class.

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

Looks up a localized string similar to A connection string must be passed to the constructor.

Looks up a localized string similar to An error occurred in your Application.

Looks up a localized string similar to Byte[] value greater than 20megs are not supported.

Looks up a localized string similar to This Configuration method is no longer supported. Use a Provider configuration instead..

Looks up a localized string similar to Connection opening failure: {0}.

Looks up a localized string similar to Couldn't load entity - invalid key provided..

Looks up a localized string similar to DataReader passed to DataReaderToObject cannot be closed.

Looks up a localized string similar to Error: .

Looks up a localized string similar to Invalid Connection String..

Looks up a localized string similar to Invalid Connection string name..

Looks up a localized string similar to Invalid encryptipon property name.

Looks up a localized string similar to Invalid hex digit: .

Looks up a localized string similar to Invalid hex string length: {0}.

Looks up a localized string similar to Invalid type for XmlType to .NET Type conversion..

Looks up a localized string similar to Invalid XML configuration file format in {0}..

Looks up a localized string similar to JSON.NET library not avaiable. Please add the Newtonsoft.Json package to your project..

Looks up a localized string similar to Missing encryption key..

Looks up a localized string similar to No active Transaction to commit..

Looks up a localized string similar to Object could not be deserialized from Xml..

Looks up a localized string similar to The Sql Server Compact data provider is not supported on .NET Core.

Looks up a localized string similar to Type Conversion not handled in StringToTypedValue for .

Looks up a localized string similar to Today.

Looks up a localized string similar to Unable to read configuration string from Sql Server field..

Looks up a localized string similar to Unable to read config information from string..

Looks up a localized string similar to Unable to retrieve DbProviderFactory for: {0}.

Looks up a localized string similar to Unsupported Provider Factory specified: {0}.

Looks up a localized string similar to Yesterday.

This class creates a generic method delegate from a MethodInfo signature converting the method call into a LateBoundMethod delegate call. Using this class allows making repeated calls very quickly. Note: this class will be very inefficient for individual dynamic method calls - compilation of the expression is very expensive up front, so using this delegate factory makes sense only if you re-use the dynamicly loaded method repeatedly. Entirely based on Nate Kohari's blog post: http://kohari.org/2009/03/06/fast-late-bound-invocation-with-expression-trees/

Creates a LateBoundMethod delegate from a MethodInfo structure Basically creates a dynamic delegate instance (code) on the fly.

Creates a LateBoundMethod from type methodname and parameter signature that is turned into a MethodInfo structure and then parsed into a dynamic delegate

LateBoundMethod is a generic method signature that is passed an instance and an array of parameters and returns an object. It basically can be used to call any method.

The instance that the dynamic method is called on

Class that provides a number of encryption utilities.

For best compatibility across platforms of the Encrypt/Decrypt methods use overloads that use the key as a byte[24] value rather than string or other sized buffers.

Replace this value with some unique key of your own Best set this in your App start up in a Static constructor

Global configuration propery that can be overridden to set the key size used for Encrypt/Decript operations. Choose between 16 bytes (not recommended except for backwards compatibility) or 24 bytes (works both in NET Full and NET Core)

Encodes a stream of bytes using DES encryption with a pass key. Lowest level method that handles all work.

Encrypts a byte buffer with a byte encryption key.

Bytes to convert The key bytes used to encode the data. Use a 24 byte key for best compatibility Optional CipherMode used. Defaults to older ECB for backwards compatibility

Encrypts a string into bytes using DES encryption with a Passkey.

Encrypts a string using Triple DES encryption with a two way encryption key.String is returned as Base64 or BinHex encoded value rather than binary.

if true returns bin hex rather than base64

Encrypts a string using Triple DES encryption with a two way encryption key. String is returned as Base64 or BinHex encoded string.

Decrypts a Byte array from DES with an Encryption Key.

Decrypts a byte buffer with a byte based encryption key

Data to encrypt The key bytes used to encode the data. Use a 24 byte key for best compatibility Optional CipherMode used. Defaults to older ECB for backwards compatibility

Decrypts a string using DES encryption and a pass key that was used for encryption and returns a byte buffer.

Returns data in useBinHex format (12afb1c3f1). Otherwise base64 is returned. String

Decrypts a string using DES encryption and a pass key that was used for encryption and returns a byte buffer.

Returns data in useBinHex format (12afb1c3f1). Otherwise base64 is returned. String

Decrypts a string using DES encryption and a pass key that was used for encryption. Class wwEncrypt

Returns data in useBinHex format (12afb1c3f1). Otherwise base64 is returned. String

Decrypts a string using DES encryption and a pass key that was used for encryption. Class wwEncrypt

Returns data in useBinHex format (12afb1c3f1). Otherwise base64 is returned. String

Decrypts a string using DES encryption and a pass key that was used for encryption. Class wwEncrypt

Returns data in useBinHex format (12afb1c3f1). Otherwise base64 is returned String

Encrypt bytes using the Data Protection API on Windows. This API uses internal keys to encrypt data which is valid for decryption only on the same machine. This is an idea storage mechanism for application registraions, service passwords and other semi-transient data that is specific to the software used on the current machine

DO NOT USE FOR DATA THAT WILL CROSS MACHINE BOUNDARIES

DO NOT USE FOR DATA THAT WILL CROSS MACHINE BOUNDARIES returns bin hex data when set (010A0D10AF)

Decrypts bytes using the Data Protection API on Windows. This API uses internal keys to encrypt data which is valid for decryption only on the same machine. This is an idea storage mechanism for application registraions, service passwords and other semi-transient data that is specific to the software used on the current machine

DO NOT USE FOR DATA THAT WILL CROSS MACHINE BOUNDARIES

DO NOT USE FOR DATA THAT WILL CROSS MACHINE BOUNDARIES returns bin hex data when set (010A0D10AF)

Generates a hash for the given plain text value and returns a base64-encoded result. Before the hash is computed, a random salt is generated and appended to the plain text. This salt is stored at the end of the hash value, so it can be used later for hash verification.

Plaintext value to be hashed. Name of the hash algorithm. Allowed values are: "MD5", "SHA1", "SHA256", "SHA384", "SHA512", "HMACMD5", "HMACSHA1", "HMACSHA256", "HMACSHA512" (if any other value is specified MD5 will be used). HMAC algorithms uses Hash-based Message Authentication Code. The HMAC process mixes a secret key with the message data, hashes the result with the hash function, mixes that hash value with the secret key again, and then applies the hash function a second time. HMAC hashes are fixed lenght and generally much longer than non-HMAC hashes of the same type. https://msdn.microsoft.com/en-us/library/system.security.cryptography.hmacsha256(v=vs.110).aspx This value is case-insensitive. Optional but recommended salt string to apply to the hash. If not passed the raw encoding is used. If salt is nullthe raw algorithm is used (useful for file hashes etc.) HMAC versions REQUIRE that salt is passed. if true returns the data as BinHex byte pair string. Otherwise Base64 is returned. Hash value formatted as a base64-encoded or BinHex stringstring.

Plaintext value to be hashed. Name of the hash algorithm. Allowed values are: "MD5", "SHA1", "SHA256", "SHA384", "SHA512", "HMACMD5", "HMACSHA1", "HMACSHA256", "HMACSHA512" (if any other value is specified MD5 will be used). HMAC algorithms uses Hash-based Message Authentication Code. The HMAC process mixes a secret key with the message data, hashes the result with the hash function, mixes that hash value with the secret key again, and then applies the hash function a second time. HMAC hashes are fixed lenght and generally much longer than non-HMAC hashes of the same type. https://msdn.microsoft.com/en-us/library/system.security.cryptography.hmacsha256(v=vs.110).aspx This value is case-insensitive. Optional but recommended salt bytes to apply to the hash. If not passed the raw encoding is used. If salt is nullthe raw algorithm is used (useful for file hashes etc.) HMAC versions REQUIRE that salt is passed. if true returns the data as BinHex byte pair string. Otherwise Base64 is returned. Hash value formatted as a base64-encoded or BinHex stringstring.

GZip encodes a memory buffer to a compressed memory buffer

Encodes a string to a gzip compressed memory buffer

Encodes a file to a gzip memory buffer

Encodes one file to another file that is gzip compressed. File is overwritten if it exists and not locked.

Creates an SHA256 or MD5 checksum of a file

SHA256,SHA512,MD5 A binhex string

Create a SHA256 or MD5 checksum from a bunch of bytes

SHA256,SHA512,MD5

Converts a byte array into a BinHex string. Example: 01552233 where the numbers are packed byte values.

Raw data to send string or null if input is null

Turns a BinHex string that contains raw byte values into a byte array

BinHex string (011a031f) just two byte hex digits strung together)

Class that provides extensible properties and methods to an existing object when cast to dynamic. This dynamic object stores 'extra' properties in a dictionary or checks the actual properties of the instance passed via constructor. This class can be subclassed to extend an existing type or you can pass in an instance to extend. Properties (both dynamic and strongly typed) can be accessed through an indexer. This type allows you three ways to access its properties: Directly: any explicitly declared properties are accessible Dynamic: dynamic cast allows access to dictionary and native properties/methods Dictionary: Any of the extended properties are accessible via IDictionary interface

Instance of object passed in

Cached type of the instance

String Dictionary that contains the extra dynamic values stored on this object/instance

Using PropertyBag to support XML Serialization of the dictionary

This constructor just works off the internal dictionary and any public properties of this object. Note you can subclass Expando.

Allows passing in an existing instance variable to 'extend'.

You can pass in null here if you don't want to check native properties and only check the Dictionary!

Create an Expando from a dictionary

Expando instance

Return both instance and dynamic names. Important to return both so JSON serialization with Json.NET works.

Try to retrieve a member by name first from instance properties followed by the collection entries.

Property setter implementation tries to retrieve value from instance first then into this object

Dynamic invocation method. Currently allows only for Reflection based operation (no ability to add methods dynamically).

Reflection Helper method to retrieve a property

Reflection helper method to set a property value

Reflection helper method to invoke a method

Convenience method that provides a string Indexer to the Properties collection AND the strongly typed properties of the object by name. // dynamic exp["Address"] = "112 nowhere lane"; // strong var name = exp["StronglyTypedProperty"] as string;

The getter checks the Properties dictionary first then looks in PropertyInfo for properties. The setter checks the instance properties before checking the Properties dictionary.

Returns and the properties of

Checks whether a property exists in the Property collection or as a property on the instance

An object factory that can create instances of types for Http Web Request and Thread Scoped object objects and value types.

Internal locking for collection storage

Returns a standard instance of an object.

Creates an instance of an object that is scoped to the current Http Web Request. The instance is cached in HttpContext.Current.Items collection and effectively acts as a request Singleton.

Create an instance scoped to a current thread.

Optional reusable key of the TLS item created

Creates either Web Request scoped object instance or value

Returns a unique ID for a given type and parameter signature

Creates a serializable string/object dictionary that is XML serializable Encodes keys as element names and values as simple values with a type attribute that contains an XML type name. Complex names encode the type name with type='___namespace.classname' format followed by a standard xml serialized format. The latter serialization can be slow so it's not recommended to pass complex types if performance is critical.

Creates an instance of a propertybag from an Xml string

Serialize

Creates a serializable string for generic types that is XML serializable. Encodes keys as element names and values as simple values with a type attribute that contains an XML type name. Complex names encode the type name with type='___namespace.classname' format followed by a standard xml serialized format. The latter serialization can be slow so it's not recommended to pass complex types if performance is critical.

Must be a reference type. For value types use type object

Not implemented - this means no schema information is passed so this won't work with ASMX/WCF services.

Serializes the dictionary to XML. Keys are serialized to element names and values as element values. An xml type attribute is embedded for each serialized element - a .NET type element is embedded for each complex type and prefixed with three underscores.

Reads the custom serialized format

Serializes this dictionary to an XML string

XML String or Null if it fails

Deserializes from an XML string

true or false

Creates an instance of a propertybag from an Xml string

A generic scheduling service that runs on a background thread and fires events in a given check frequency.

Determines the status the Scheduler

The frequency in how often the main method is executed. Given in milli-seconds.

Optional URL that is pinged occasionally to ensure the server stays alive. If empty hits root web page (~/yourapp/)

Event that is fired when

Internal property used for cross thread locking

Memory based queue that contains items and allows retrieval of items. Note memory based! This means if app crashses or is shut down messages might get lost. If message persistence is important your scheduling store should be a database. You can use the QueueMessageManager object for example.

Starts the background thread processing

Frequency that checks are performed in seconds

Starts the background Thread processing

Causes the processing to stop. If the operation is still active it will stop after the current message processing completes

Runs the actual processing loop by checking the mail box

Handles a scheduled operation. Checks to see if an event handler is set up and if so calls it. This method can also be overrriden in a subclass to implemnent custom functionality.

This method is called if an error occurs during processing of the OnExecuteScheduledEvent request Override this method in your own implementation to provide for error logging or other handling of an error that occurred in processing. Ideally this shouldn't be necessary - your OnexecuteScheduledEvent code should handle any errors internally and provide for its own logging mechanism but this is here as an additional point of control.

Exception occurred during item execution

Adds an item to the queue.

Returns the next queued item or null on failure.

Optional routine that pings a Url on the server to keep the server alive. Use this to avoid IIS shutting down your AppPools

A simple item wrapper that allows separating items by type.

Allows identifying items by type

Any text data you want to submit

Any binary data you want to submit

The initial date when the item was created or submitted.

A very simple flat object serializer that can be used for intra application serialization. It creates a very compact positional string of properties. Only serializes top level properties, with no nesting support and only simple properties or those with a type converter are supported. Complex properties or non-two way type convertered values are ignored. Creates strings in the format of: Rick|rstrahl@west-wind.com|1|True|3/29/2013 1:32:31 PM|1

This component is meant for intra application serialization of very compact objects. A common use case is for state serialization for cookies or a Forms Authentication ticket to minimize the amount of space used - the output produced here contains only the actual data, no property info or validation like other serialization formats. Use only on small objects when size and speed matter otherwise use a JSON/XML/Binary serializer or the ASP.NET LosFormatter object.

Serializes a flat object's properties into a String separated by a separator character/string. Only top level properties are serialized.

Only serializes top level properties, with no nesting support and only simple properties or those with a type converter are 'serialized'. All other property types use ToString(). The object to serialize Optional separator character or string. Default is |

Deserializes an object previously serialized by SerializeObject.

Deserializes an object serialized with SerializeObject.

A query string or UrlEncoded form parser and editor class that allows reading and writing of urlencoded key value pairs used for query string and HTTP form data. Useful for parsing and editing querystrings inside of non-Web code that doesn't have easy access to the HttpUtility class.

Supports multiple values per key

Holds the original Url that was assigned if any Url must contain // to be considered a url

Determines whether plus signs in the UrlEncoded content are treated as spaces.

Always pass in a UrlEncoded data or a URL to parse from unless you are creating a new one from scratch.

Pass a query string or raw Form data, or a full URL. If a URL is parsed the part prior to the ? is stripped but saved. Then when you write the original URL is re-written with the new query string.

Assigns multiple values to the same key

Parses the query string into the internal dictionary and optionally also returns this dictionary

Query string key value pairs or a full URL. If URL is passed the URL is re-written in Write operation

Writes out the urlencoded data/query string or full URL based on the internally set values.

urlencoded data or url

Internally used class that is used to expand links in text strings.

Expands links into HTML hyperlinks inside of text or HTML.

The text to expand Target frame where links are displayed Allows parsing of links in the following format [text|www.site.com]

Expands links into HTML hyperlinks inside of text or HTML.

The text to expand

Internal RegExEvaluator callback

Utility library for common data operations.

Generates a unique Id as a string of up to 16 characters. Based on a GUID and the size takes that subset of a the Guid's 16 bytes to create a string id. String Id contains numbers and lower case alpha chars 36 total. Sizes: 6 gives roughly 99.97% uniqueness. 8 gives less than 1 in a million doubles. 16 will give near full GUID strength uniqueness

Number of characters to generate between 8 and 16 Any additional characters you allow in the string. You can add upper case letters and symbols which are not included in the default which includes only digits and lower case letters.

Generates a unique numeric ID. Generated off a GUID and returned as a 64 bit long value

Returns a random integer in a range of numbers a single seed value.

The minimum value The max value *including* this value (unlike Random.Next() which doesn't include it)

Returns an index into a byte array to find sequence of of bytes. Note: You can use Span.IndexOf() where available instead.

byte array to be searched bytes to find

Returns an index into a byte array to find a string in the byte array. Exact match using the encoding provided or UTF-8 by default.

Source buffer to look for string string to search for (case sensitive) Optional encoding to use - defaults to UTF-8 if null

Copies the content of a data row to another. Runs through the target's fields and looks for fields of the same name in the source row. Structure must mathc or fields are skipped.

Populates an object passed in from values in a data row that's passed in.

Data row with values to fill from Object to file values from data row

Copies the content of an object to a DataRow with matching field names. Both properties and fields are copied. If a field copy fails due to a type mismatch copying continues but the method returns false

Coverts a DataTable to a typed list of items

Type to

Copies the content of one object to another. The target object 'pulls' properties of the first.

Copies the data of one object to another. The target object 'pulls' properties of the first. This any matching properties are written to the target. The object copy is a shallow copy only. Any nested types will be copied as whole values rather than individual property assignments (ie. via assignment)

The source object to copy from The object to copy to A comma delimited list of properties that should not be copied Reflection binding access

Coverts a DataTable to a typed list of items

Creates a list of a given type from all the rows in a DataReader. Note this method uses Reflection so this isn't a high performance operation, but it can be useful for generic data reader to entity conversions on the fly and with anonymous types.

An open DataReader that's in position to read Optional - comma delimited list of fields that you don't want to update Optional - Cached PropertyInfo dictionary that holds property info data for this object. Can be used for caching hte PropertyInfo structure for multiple operations to speed up translation. If not passed automatically created. DataReader is not closed by this method. Make sure you call reader.close() afterwards

Creates an IEnumerable of T from an open DataReader instance. Note this method uses Reflection so this isn't a high performance operation, but it can be useful for generic data reader to entity conversions on the fly and with anonymous types.

Populates the properties of an object from a single DataReader row using Reflection by matching the DataReader fields to a public property on the object passed in. Unmatched properties are left unchanged. You need to pass in a data reader located on the active row you want to serialize. This routine works best for matching pure data entities and should be used only in low volume environments where retrieval speed is not critical due to its use of Reflection.

Instance of the DataReader to read data from. Should be located on the correct record (Read() should have been called on it before calling this method) Instance of the object to populate properties on Optional - A comma delimited list of object properties that should not be updated Optional - Cached PropertyInfo dictionary that holds property info data for this object

The default SQL date used by InitializeDataRowWithBlanks. Considered a blank date instead of null.

Initializes a Datarow containing NULL values with 'empty' values instead. Empty values are: String - "" all number types - 0 or 0.00 DateTime - Value of MinimumSqlData (1/1/1900 by default); Boolean - false Binary values and timestamps are left alone

DataRow to be initialized

Loads a SQL Provider factory based on the DbFactory type name and assembly.

Type name of the DbProviderFactory Short assembly name of the provider factory. Note: Host project needs to have a reference to this assembly

This method loads various providers dynamically similar to the way that DbProviderFactories.GetFactory() works except that this API is not available on .NET Standard 2.0

Returns a provider factory using the old Provider Model names from full framework .NET. Simply calls DbProviderFactories.

Maps a SqlDbType to a .NET type

Maps a DbType to a .NET native type

Converts a .NET type into a DbType value

Converts a .NET type into a SqlDbType.

Creates a Command object and opens a connection

Returns a SqlDataReader object from a SQL string. Please ensure you close the Reader object

Returns a DataTable from a Sql Command string passed in.

Closes a connection

DebugUtils class contains various utility methods for debugging and diagnostic tasks

Returns the innermost Exception for an object

Returns an array of the entire exception list in reverse order (innermost to outermost exception)

The original exception to work off Array of Exceptions from innermost to outermost

Returns the text with a prefix of line numbers

Line format used to create the line. 0 is the line number, 1 is the text.

Returns true if the date is between or equal to one of the two values.

DateTime Base, from where the calculation will be preformed. Start date to check for End date to check for boolean value indicating if the date is between or equal to one of the two values

Returns 12:59:59pm time for the date passed. Useful for date only search ranges end value

Date to convert

Returns 12:00am time for the date passed. Useful for date only search ranges start value

Date to convert

Returns the very end of the given month (the last millisecond of the last hour for the given date)

DateTime Base, from where the calculation will be preformed. Returns the very end of the given month (the last millisecond of the last hour for the given date)

Returns the Start of the given month (the fist millisecond of the given date)

DateTime Base, from where the calculation will be preformed. Returns the Start of the given month (the fist millisecond of the given date)

Extends dictionary classes with XML

Serializes the dictionary to an XML string

Loads the dictionary from an Xml string

Flattens a tree to a plain enumerable for querying.

Enumeration to work on Expression that points at the element list to select from var topics = topicTree.FlattenTree(t=> t.Topics);

wwUtils class which contains a set of common utility classes for Formatting strings Reflection Helpers Object Serialization Stream Manipulation

Copies the content of the one stream to another. Streams must be open and stay open.

Copies the content of one stream to another by appending to the target stream Streams must be open when passed in.

Opens a stream reader with the appropriate text encoding applied.

This function returns the actual filename of a file that exists on disk. If you provide a path/file name that is not proper cased as input, this function fixes it up and returns the file using the path and file names as they exist on disk. If the file doesn't exist the original filename is returned.

A filename to check On disk file name and path with the disk casing

Returns a compact path with elipsis from a long path

Original path to potentially trim Max length of the path string returned

Returns a relative path string from a full path based on a base path provided.

The path to convert. Can be either a file or a directory The base path on which relative processing is based. Should be a directory. String of the relative path. Examples of returned values: test.txt, ..\test.txt, ..\..\..\test.txt, ., .., subdir\test.txt

Expands Path Environment Variables like %appdata% in paths.

Path with potential environment variables.

Returns a safe filename from a string by stripping out illegal characters

Filename to fix up String value to replace illegal chars with. Defaults empty string Optional - replace spaces with a specified string. Fixed up string

Returns a safe filename in CamelCase

Normalizes a file path to the operating system default slashes.

Normalizes path with slashes and forces a trailing slash on the end of the path.

Path to pass in

Adds a trailing slash to a path if there isn't one.

A file system path

Detects the byte order mark of a file and returns an appropriate encoding for the file.

Copies directories using either top level only or deep merge copy. Copies a directory by copying files from source folder to target folder. If folder(s) don't exist they are created. deepCopy copies files in sub-folders and merges them into the target folder. Unless you specify deleteFirst, files are copied and overwrite or add to existing structure, leaving old files in place. Use deleteFirst if you want a new structure with only the source files.

Path to copy from Path to copy to If true deletes target folder before copying. Otherwise files are merged from source into target.

Deletes files in a folder based on a file spec recursively

0 when no errors, otherwise number of files that have failed to delete (usually locked)

Deletes files based on a file spec and a given timeout. This routine is useful for cleaning up temp files in Web applications.

A filespec that includes path and/or wildcards to select files The timeout - if files are older than this timeout they are deleted

Creates an MD5 checksum of a file

SHA256, SHA512, SHA1, MD5 BinHex file hash

Determines whether an item is contained in a list of other items

bool exists = Inlist<string>("Rick","Mike","Billy","Rick","Frank"); // true; Any type The item to look for Any number of items to search (params)

Html string and formatting utilities

Replaces and and Quote characters to HTML safe equivalents.

HTML to convert Returns an HTML string of the converted text

Strips HTML tags out of an HTML string and returns just the text.

Html String

Fixes a plain text field for display as HTML by replacing carriage returns with the appropriate br and p tags for breaks.

Input string Fixed up string

Method that handles handles display of text by breaking text. Unlike the non-encoded version it encodes any embedded HTML text

HTML-encodes a string and returns the encoded string.

The text string to encode. The HTML-encoded text.

Create an Href HTML link

Creates an HREF HTML Link

Returns an IMG link as a string. If the image is null or empty a blank string is returned.

any additional attributes added to the element

Resolves a URL based on the current HTTPContext Note this method is added here internally only to support the HREF() method and ~ expansion on urls.

Creates an Abstract from an HTML document. Strips the HTML into plain text, then creates an abstract.

Sanitizes HTML to some of the most of

This provides rudimentary HTML sanitation catching the most obvious XSS script attack vectors. For mroe complete HTML Sanitation please look into a dedicated HTML Sanitizer. input html A list of HTML tags that are stripped. Sanitized HTML

Simple HTTP request helper to let you retrieve data from a Web server and convert it to something useful.

Retrieves and Http request and returns data as a string.

A url to call for a GET request without custom headers string of HTTP response

Retrieves and Http request and returns data as a string.

Pass HTTP request configuration parameters object to set the URL, Verb, Headers, content and more string of HTTP response

Makes an HTTP with option JSON data serialized from an object and parses the result from JSON back into an object. Assumes that the service returns a JSON response

The type of the object returned Configuration object for the HTTP request made to the server. deserialized value/object from returned JSON data

Retrieves and Http request and returns data as a string.

The Url to access string of HTTP response

Retrieves and Http request and returns data as a string.

Pass HTTP request configuration parameters object to set the URL, Verb, Headers, content and more string of HTTP response

Makes an HTTP with option JSON data serialized from an object and parses the result from JSON back into an object. Assumes that the service returns a JSON response and that any data sent is json.

The type of the object returned Configuration object for the HTTP request made to the server. deserialized value/object from returned JSON data

Configuration object for Http Requests used by the HttpUtils methods. Allows you to set the URL, verb, headers proxy and credentials that are then passed to the HTTP client.

The URL to send the request to

The HTTP verb to use when sending the request

The Request content to send to the server. Data can be either string or byte[] type

Content Encoding for the data sent to to server

When true data is not translated. For example when using JSON Request if you want to send raw POST data rather than a serialized object.

The content type of any request data sent to the server in the Data property.

The request timeout in milliseconds. 0 for default (20 seconds typically)

Any Http request headers you want to set for this request

Authentication information for this request

Determines whether credentials pre-authenticate

An optional proxy to set for this request

Capture request string data that was actually sent to the server.

Captured string Response Data from the server

Capture binary Response data from the server when using the Data methods rather than string methods.

The HTTP Status code of the HTTP response

Instance of the full HttpResponse object that gives access to the full HttpWebResponse object to provide things like Response headers, status etc.

The User Agent string sent to the server

Customized version of WebClient that provides access to the Response object so we can read result data from the Response.

Intializes this instance of WebClient with settings values

Summary description for wwImaging.

Creates a resized bitmap from an existing image on disk. Resizes the image by creating an aspect ratio safe image. Image is sized to the larger size of width height and then smaller size is adjusted by aspect ratio. Image is returned as Bitmap - call Dispose() on the returned Bitmap object

Bitmap or null

Resizes an image from byte array and returns a Bitmap. Make sure you Dispose() the bitmap after you're done with it!

Resizes an image and saves the image to a file

If using a jpeg image

Resizes an image from a bitmap. Note image will resize to the larger of the two sides

Bitmap to resize new width new height resized or original bitmap. Be sure to Dispose this bitmap

Adjusts an image to a specific aspect ratio by clipping from the center outward - essentially capturing the center to fit the width/height of the aspect ratio.

Stream to an image Aspect ratio default is 16:9 Optionally resize with to this width (if larger than height) Optionally resize to this height (if larger than width) Bitmap image - make sure to dispose this image

Adjusts an image to a specific aspect ratio by clipping from the center outward - essentially capturing the center to fit the width/height of the aspect ratio.

Saves a jpeg BitMap to disk with a jpeg quality setting. Does not dispose the bitmap.

Bitmap to save file to write it to

Saves a jpeg BitMap to disk with a jpeg quality setting. Does not dispose the bitmap.

Bitmap to save Binary stream to write image data to

Rotates an image and writes out the rotated image to a file.

The original image to roatate The output file of the rotated image file. If not passed the original file is overwritten Type of rotation to perform

Opens the image and writes it back out, stripping any Exif data

Image to remove exif data from image quality 0-100 (100 no compression)

If the image contains image rotation Exif data, apply the image rotation and remove the Exif data. Optionally also allows for image resizing in the same operation.

Image file to work on Jpg

A quick lookup for getting image encoders

Tries to return an image format

Image format or ImageFormat.Emf if no match was found

Returns the image media type for a give file extension based on a filename or url passed in.

JSON Serialization helper class that uses JSON.NET. This class serializes JSON to and from string and files on disk.

JSON.NET is loaded dynamically at runtime to avoid hard linking the Newtonsoft.Json.dll to Westwind.Utilities. Just make sure that your project includes a reference to JSON.NET when using this class.

Serializes an object to an XML string. Unlike the other SerializeObject overloads this methods *returns a string* rather than a bool result!

Value to serialize Determines if a failure throws or returns null null on error otherwise the Xml String. If null is passed in null is also returned so you might want to check for null before calling this method.

Serializes an object instance to a JSON file.

the value to serialize Full path to the file to write out with JSON. Determines whether exceptions are thrown or false is returned if true pretty-formats the JSON with line breaks true or false

Deserializes an object from file and returns a reference.

name of the file to serialize to The Type of the object. Use typeof(yourobject class) determines whether we use Xml or Binary serialization determines whether failure will throw rather than return null on failure Instance of the deserialized object or null. Must be cast to your object type

Takes a single line JSON string and pretty formats it using indented formatting.

Dynamically creates an instance of JSON.NET

If true throws exceptions otherwise returns null Dynamic JsonSerializer instance

Runs an operation and ignores any Exceptions that occur. Returns true or falls depending on whether catch was triggered

lambda that performs an operation that might throw

Runs an function that returns a value and ignores any Exceptions that occur. Returns true or falls depending on whether catch was triggered

parameterless lamda that returns a value of T Default value returned if operation fails

Retrieves a base domain name from a full domain name. For example: www.west-wind.com produces west-wind.com

Dns Domain name as a string

Returns the base domain from a domain name Example: http://www.west-wind.com returns west-wind.com

Collection of Reflection and type conversion related utility functions

Binding Flags constant to be reused for all Reflection access methods.

Creates an instance from a type by calling the parameterless constructor. Note this will not work with COM objects - continue to use the Activator.CreateInstance for COM objects. Class wwUtils

The type from which to create an instance. object

Creates an instance of a type based on a string. Assumes that the type's

Helper routine that looks up a type name and tries to retrieve the full type reference using GetType() and if not found looking in the actively executing assemblies and optionally loading the specified assembly name.

type to load Optional assembly name to load from if type cannot be loaded initially. Use for lazy loading of assemblies without taking a type dependency. null

Overload for backwards compatibility which only tries to load assemblies that are already loaded in memory.

Creates a COM instance from a ProgID. Loads either Exe or DLL servers.

Try to load an assembly into the application's app domain. Loads by name first then checks for filename

Assembly name or full path null on failure

The string to convert from The type to convert to Culture used for numeric and datetime values. object. Throws exception if it cannot be converted.

Generic version allow for automatic type conversion without the explicit type parameter

Type to be converted to input string value to be converted Culture applied to conversion

The Value or Object to convert to a string Culture for numeric and DateTime values Return string for unsupported types string

Retrieve a field dynamically from an object. This is a simple implementation that's straight Reflection and doesn't support indexers.

Object to retreve Field from name of the field to retrieve

Parses Properties and Fields including Array and Collection references. Used internally for the 'Ex' Reflection methods.

Parses Properties and Fields including Array and Collection references.

Returns a property or field value using a base object and sub members including . syntax. For example, you can access: oCustomer.oData.Company with (this,"oCustomer.oData.Company") This method also supports indexers in the Property value such as: Customer.DataSet.Tables["Customers"].Rows[0]

Parent object to 'start' parsing from. Typically this will be the Page. The property to retrieve. Example: 'Customer.Entity.Company'

Returns a PropertyInfo object for a given dynamically accessed property Property selection can be specified using . syntax ("Address.Street" or "DataTable[0].Rows[1]") hence the 'Ex' name for this function.

Returns a PropertyInfo structure from an extended Property reference

Sets the property on an object. This is a simple method that uses straight Reflection and doesn't support indexers.

Object to set property on Name of the property to set value to set it to

Sets the field on an object. This is a simple method that uses straight Reflection and doesn't support indexers.

Object to set property on Name of the field to set value to set it to

Sets a value on an object. Supports . syntax for named properties (ie. Customer.Entity.Company) as well as indexers.

Object to set the property on. Property to set. Can be an object hierarchy with . syntax and can include indexers. Examples: Customer.Entity.Company, Customer.DataSet.Tables["Customers"].Rows[0] Value to set the property to

Calls a method on an object dynamically. This version requires explicit specification of the parameter type signatures.

Instance of object to call method on The method to call as a stringToTypedValue Specify each of the types for each parameter passed. You can also pass null, but you may get errors for ambiguous methods signatures when null parameters are passed any variable number of parameters. object

Calls a method on an object dynamically. This version doesn't require specific parameter signatures to be passed. Instead parameter types are inferred based on types passed. Note that if you pass a null parameter, type inferrance cannot occur and if overloads exist the call may fail. if so use the more detailed overload of this method.

Calls a method on an object with extended . syntax (object: this Method: Entity.CalculateOrderTotal)

Retrieves a value from a static property by specifying a type full name and property

Full type name (namespace.class) Property to get value from

Returns a static property from a given type

Type instance for the static property Property name as a string

Retrieve a property value from an object dynamically. This is a simple version that uses Reflection calls directly. It doesn't support indexers.

Object to make the call on Property to retrieve Object - cast to proper type

Returns a List of KeyValuePair object

Retrieve a dynamic 'non-typelib' property

Object to make the call on Property to retrieve

Returns a property or field value using a base object and sub members including . syntax. For example, you can access: oCustomer.oData.Company with (this,"oCustomer.oData.Company")

Parent object to 'start' parsing from. The property to retrieve. Example: 'oBus.oData.Company'

Sets the property on an object.

Object to set property on Name of the property to set value to set it to

Sets the value of a field or property via Reflection. This method alws for using '.' syntax to specify objects multiple levels down. ReflectionUtils.SetPropertyEx(this,"Invoice.LineItemsCount",10) which would be equivalent of: Invoice.LineItemsCount = 10;

Object to set the property on. Property to set. Can be an object hierarchy with . syntax. Value to set the property to

Wrapper method to call a 'dynamic' (non-typelib) method on a COM object

1st - Method name, 2nd - 1st parameter, 3rd - 2nd parm etc.

Calls a method on a COM object with '.' syntax (Customer instance and Address.DoSomeThing method)

the object instance on which to call method The method or . syntax path to the method (Address.Parse) Any number of parameters

A set of utilities functions related to security.

Logs on a user and changes the current process impersonation to that user. IMPORTANT: Returns a WindowsImpersonationContext and you have to either dispose this instance or call RevertImpersonation with it.

Requires Full Trust permissions in ASP.NET Web Applications. WindowsImpersonation Context. Call RevertImpersonation() to clear the impersonation or Dispose() instance.

Releases an impersonation context and releases associated resources

WindowsImpersonation context created with ImpersonateUser

Serializes an object instance to a file.

the object instance to serialize determines whether XML serialization or binary serialization is used

Overload that supports passing in an XML TextWriter.

Note the Writer is not closed when serialization is complete so the caller needs to handle closing. object to serialize XmlTextWriter instance to write output to Determines whether false is returned on failure or an exception is thrown

Serializes an object into an XML string variable for easy 'manual' serialization

object to serialize resulting XML string passed as an out parameter true or false

Serializes an object into a string variable for easy 'manual' serialization

Out parm that holds resulting XML string If true causes exceptions rather than returning false

Serializes an object instance to a file.

the object instance to serialize determines whether XML serialization or binary serialization is used

Serializes an object to an XML string. Unlike the other SerializeObject overloads this methods *returns a string* rather than a bool result!

Determines if a failure throws or returns null null on error otherwise the Xml String. If null is passed in null is also returned so you might want to check for null before calling this method.

Deserializes an object from file and returns a reference.

name of the file to serialize to The Type of the object. Use typeof(yourobject class) determines whether we use Xml or Binary serialization Instance of the deserialized object or null. Must be cast to your object type

Deserializes an object from file and returns a reference.

Deserialize an object from an XmlReader object.

Deseializes a binary serialized object from a byte array

Returns a string of all the field value pairs of a given object. Works only on non-statics.

Windows specific shell utility functions

Opens a File or Folder in Explorer. If the path is a file Explorer is opened in the parent folder with the file selected

Executes a Windows process with given command line parameters

Executable to run Command Line Parameters passed to executable Timeout of the process in milliseconds. Pass -1 to wait forever. Pass 0 to not wait. Hidden, Normal etc. process exit code or 0 if run and forget. 1460 for time out. -1 on error

Executes a Windows process with given command line parameters and captures console output into a string. Writes command output to the output StringBuilder from StdOut and StdError.

Executable to run Command Line Parameters passed to executable Timeout of the process in milliseconds. Pass -1 to wait forever. Pass 0 to not wait. Pass in a string reference that will receive StdOut and StdError output Hidden, Normal, etc. process exit code or 0 if run and forget. 1460 for time out. -1 on error

Executes a Windows process with given command line parameters and captures console output into a string. Pass in a String Action that receives output from StdOut and StdError as it is written (one line at a time).

Executable to run Command Line Parameters passed to executable Timeout of the process in milliseconds. Pass -1 to wait forever. Pass 0 to not wait. Delegate to let you capture streaming output of the executable to stdout and stderror. Hidden, Normal etc. process exit code or 0 if run and forget. 1460 for time out. -1 on error

Executes a Windows process with given command line parameters and captures console output into a string. Writes original output into the application Console which you can optionally redirect to capture output from the command line operation using `Console.SetOut` or `Console.SetError`.

Executable to run Timeout of the process in milliseconds. Pass -1 to wait forever. Pass 0 to not wait. StringBuilder that will receive StdOut and StdError output Action to capture stdout and stderror output for you to handle process exit code or 0 if run and forget. 1460 for time out. -1 on error

Opens a Terminal window in the specified folder

Powershell, Command or Bash false if process couldn't be started - most likely invalid link

Uses the Shell Extensions to launch a program based on URL moniker or file name Basically a wrapper around ShellExecute

Any URL Moniker that the Windows Shell understands (URL, Word Docs, PDF, Email links etc.)

Displays a string in in a browser as HTML. Optionally provide an alternate extension to display in the appropriate text viewer (ie. "txt" likely shows in NotePad)

Shows a string as HTML

Displays a large Text string as a text file in the systems' default text viewer (ie. NotePad)

Simple method to retrieve HTTP content from the Web quickly

Url to access Http response text or null

Simple method to retrieve HTTP content from the Web quickly

Url to access

Retrieves a buffer of binary data from a URL using a plain HTTP Get.

Url to access Response bytes or null on error

Retrieves a buffer of binary data from a URL using a plain HTTP Get.

Url to access ref parm to receive an error message response bytes or null on error

String utility class that provides a host of string related operations

Trims a sub string from a string.

Trims a string to a specific number of max characters

Replicates an input string n number of times

Replicates a character n number of times and returns a string

Finds the nth index of string in a string

Returns the nth Index of a character in a string

Finds the nth index of strting in a string

Finds the nth index of in a string from the end.

Return a string in proper Case format

Takes a phrase and turns it into CamelCase text. White Space, punctuation and separators are stripped

Text to convert to CamelCase

Tries to create a phrase string from CamelCase text. Will place spaces before capitalized letters. Note that this method may not work for round tripping ToCamelCase calls, since ToCamelCase strips more characters than just spaces.

Extracts a string from between a pair of delimiters. Only the first instance is found.

Input String to work on Beginning delimiter ending delimiter Determines whether the search for delimiters is case sensitive Extracted string or string.Empty on no match

String replace function that supports replacing a specific instance with case insensitivity

Original input string The string that is to be replaced The replacement string Instance of the FindString that is to be found. 1 based. If Instance = -1 all are replaced Case insensitivity flag updated string or original string if no matches

Replaces a substring within a string with another substring with optional case sensitivity turned off.

String to do replacements on The string to find The string to replace found string wiht If true case insensitive search is performed updated string or original string if no matches

Truncate a string to maximum length.

Text to truncate Maximum length Trimmed string

Returns an abstract of the provided text by returning up to Length characters of a text string. If the text is truncated a ... is appended.

Text to abstract Number of characters to abstract to string

Terminates a string with the given end string/character, but only if the text specified doesn't already exist and the string is not empty.

String to terminate String to terminate the text string with

Returns the number or right characters specified

full string to work with number of right characters to return

Determines if a string is contained in a list of other strings

String.Contains() extension method that allows to specify case

Input text text to search for Case sensitivity options

Parses a string into an array of lines broken by \r\n or \n

String to check for lines Optional - max number of lines to return array of strings, or null if the string passed was a null

Returns a line count for a string

string to count lines for

Strips all non digit values from a string and only returns the numeric string.

Tokenizes a string based on a start and end string. Replaces the values with a token text (#@#1#@# for example). You can use Detokenize to get the original values back

Detokenizes a string tokenized with TokenizeString. Requires the collection created by detokenization

Parses an string into an integer. If the text can't be parsed a default text is returned instead

Input numeric string to be parsed Optional default text if parsing fails Optional NumberFormat provider. Defaults to current culture's number format

Parses an string into an decimal. If the text can't be parsed a default text is returned instead

Creates short string id based on a GUID hashcode. Not guaranteed to be unique across machines, but unlikely to duplicate in medium volume situations.

Creates a new random string of upper, lower case letters and digits. Very useful for generating random data for storage in test data.

The number of characters of the string to generate randomized string

UrlEncodes a string without the requirement for System.Web

Encodes a few additional characters for use in paths Encodes: . #

UrlDecodes a string without requiring System.Web

String to decode. decoded string

Retrieves a text by key from a UrlEncoded string.

UrlEncoded String Key to retrieve text for returns the text or "" if the key is not found or the text is blank

Allows setting of a text in a UrlEncoded string. If the key doesn't exist a new one is set, if it exists it's replaced with the new text.

A UrlEncoded string of key text pairs

Turns a BinHex string that contains raw byte values into a byte array

BinHex string (just two byte hex digits strung together)

Converts a byte array into a BinHex string. BinHex is two digit hex byte values squished together into a string.

Raw data to send BinHex string or null if input is null

Converts a string into bytes for storage in any byte[] types buffer or stream format (like MemoryStream).

The character encoding to use. Defaults to Unicode

Converts a byte array to a stringUtils

raw string byte data Character encoding to use. Defaults to Unicode

Encodes an integer into a string by mapping to alpha and digits (36 chars) chars are embedded as lower case Example: 4zx12ss

Decodes a base36 encoded string to an integer

Normalizes linefeeds to the appropriate

The text to fix up Type of linefeed to fix up to

Strips any common white space from all lines of text that have the same common white space text. Effectively removes common code indentation from code blocks for example so you can get a left aligned code snippet.

Simple Logging method that allows quickly writing a string to a file

if not specified used UTF-8

Creates a Stream from a string. Internally creates a memory stream and returns that.

Retrieves a text from an XML-like string

Time Utilities class provides date and time related routines.

Displays a date in friendly format.

Today,Yesterday,Day of week or a string day (Jul 15, 2008)

Returns a short date time string

Displays a number of milliseconds as friendly seconds, hours, minutes Pass -1 to get a blank date.

the elapsed milliseconds to display time for string in format of just now or 1m ago, 2h ago

Displays the elapsed time friendly seconds, hours, minutes

Timespan of elapsed time string in format of just now or 1m ago, 2h ago

Converts a fractional hour value like 1.25 to 1:15 hours:minutes format

Decimal hour value An optional format string where {0} is hours and {1} is minutes (ie: "{0}h:{1}m").

Converts a fractional hour value like 1.25 to 1:15 hours:minutes format

Decimal hour value

Rounds an hours value to a minute interval 0 means no rounding

Minutes to round up or down to

Rounds a date value to a given minute interval

Original time value Number of minutes to round up or down to

Creates a DateTime value from date and time input values

Creates a DateTime Value from a DateTime date and a string time value.

Converts the passed date time value to Mime formatted time string

Truncates a DateTime value to the nearest partial value.

From: http://stackoverflow.com/questions/1004698/how-to-truncate-milliseconds-off-of-a-net-datetime

Returns TimeZone adjusted time for a given from a Utc or local time. Date is first converted to UTC then adjusted.

Determines how date time values are rounded

Windows specific system and information helpers Helper class that provides Windows and .NET Version numbers.

Returns the Windows major version number for this computer. based on this: http://stackoverflow.com/questions/21737985/windows-version-in-c-sharp/37716269#37716269

Returns the Windows minor version number for this computer.

Returns whether or not the current computer is a server or not.

Returns the .NET framework version installed on the machine as a string of 4.x.y version

Minimum version supported is 4.0

Returns a Windows Version string including build number

String utility class that provides a host of string related operations

Turns a string into a properly XML Encoded string. Uses simple string replacement. Also see XmlUtils.XmlString() which uses XElement to handle additional extended characters.

Plain text to convert to XML Encoded string If true encodes single and double quotes. When embedding element values quotes don't need to be encoded. When embedding attributes quotes need to be encoded. XML encoded string Invalid character in XML string

Retrieves a result string from an XPATH query. Null if not found.

Gets an Enum value from an xml node. Returns enum type value. Either flag or string based keys will work

Retrieves a result int value from an XPATH query. 0 if not found.

Retrieves a result decimal value from an XPATH query. 0 if not found.

Retrieves a result bool from an XPATH query. false if not found.

Retrieves a result DateTime from an XPATH query. 1/1/1900 if not found.

Gets an attribute by name

value or null if not available

Returns an integer value from an attribute

Returns an bool value from an attribute

Converts a .NET type into an XML compatible type - roughly

Creates an Xml NamespaceManager for an XML document by looking at all of the namespaces defined on the document root element.

The XmlDom instance to attach the namespacemanager to The prefix to use for prefix-less nodes (which are not supported if any namespaces are used in XmlDoc).

MemoryStream Extension Methods that provide conversions to and from strings

Returns the content of the stream as a string

Writes the specified string into the memory stream