Vascor.Library

Name of the element to extract the value from in the given section. Determines if the method should throw an exception when the element is not found or return nothing. A string equal to the value of a given key in a configuration file.

This method will read the appSettings node in Web.config or App.config and returns the value of the Key requested. If the appSettings node is not found in Web.config or App.config, it will try to read from the appSettings node in Machine.config. If the appSettings node is not found at all, or if the Key is not found at all, or if the value of the Key is empty, it will try to read from a custom section in Machine.config that is pointed to by the value of the Machine.Config.SectionName key defined in the appSettings node. If that custom section is not found, or if the key is not found, or if the value of the key is empty, it will try to read from the enterprise config section. If the enterprise config section is not found, or if the key is not found in the enterprise config setion, or if the value of the key is at all empty, and if blnIsOptional is False, it will throw an exception.

This method will get the value of the key from the specified config section. If the specified config section is not found, or if the key is not found, or if the value of the key is empty, and blnIsOptional equals False, it will throw an exception. For this method to work properly, the handler of the config section must be of type NameValueSectionHandler.

Section of the config file to locate the Key. Name of the element to extract the value from in the given section. Determines if the method should throw an exception when the element is not found or return nothing. A string equal to the value of a given key in a configuration file. test

This method will get the value of the key from the specified config section. If the specified config section is not found, or if the key is not found, or if the value of the key is empty, it will try to read from the enterprise config section. If the enterprise config section is not found, or if the key is not found in the enterprise config setion, or if the value of the key is at all empty, and if blnIsOptional is False, it will throw an exception.

Some helpful functions for dealing with data

10/13/2005 Matt Ryavec Some helpful functions for dealing with data. 09/11/2008 Justin Bailey Added ObjectDataSource methods and related Imports.

Get a string filter and set the Filter parameters for the specified ObjectDataSource and list of filter parameters. Controls in the list will be checked and omitted if no value is found. Support for Integer types is limited when blnAsString is set to false--see the notes on the method. This method group could be enriched to support more controls and scenarios used with the ObjectDataSource. Dim strFilterExpression As String = GetODSFilter(lstFilterParameters, odsMyObjectDataSource, "AND", True) If odsMyObjectDataSource.FilterParameters.Count > 0 Then odsMyObjectDataSource.FilterExpression = strFilterExpression.ToString() odsMyObjectDataSource.DataBind() 'Rebind to bubble any exceptions from here. ...

Current page instance used to determine if the the Filter Control values are empty or not. List of ControlParameters available to be filtered by. Target ObjectDataSource in which to apply the valid filter parameters. Operator for multiple strings. AND or OR, etc. Treat all parameter values as a String or allow default typing such as Integer etc. This should be set to false when a DropDownList containing ID lookup values is used. String FilterExpression to be applied to the ObjectDataSource containing only controls that have values and can be applied to the filter expression string. This is not automatically added to the ObjectDataSource so that customizations can be made in light of the limitations of this method. 03/13/2008 Justin Bailey Added. This is a very limited method, but allows basic filtering for TextBoxes and DropDownLists, specifically. See method comments for known limitations and workarounds already in place. 09/11/2008 Justin Bailey Moved to DataUtility and added strOperator and blnAsString to support a more consistent behavior across string values containing integers.

Build a filter expression string based on a parameter name (field name) and its index for use in a Starts With filter. *Integer types will use >= instead of LIKE if blnAsString is false. For full integer support, use a custom method.

Control parameter for the expression. Index of the control parameter to be added to the generated expression. Operator for multiple strings. AND or OR, etc. Treat all parameter values as a String, forcing "{0} LIKE '{1}'" or allow default typing such as Integer etc through the TypeCode of the ControlParameter. This should be set to false when a DropDownList containing ID lookup values is used. "[strOperator] strParamName LIKE (or = or >=) {intParamCount}% " with the brackets indicating the dependence on intParamCount > 0. 03/13/2008 Justin Bailey Created. This is very specific for this use, but could be integrated into more rich "filter builder" method or class. 09/11/2008 Justin Bailey Moved to DataUtility and added blnAsString to support a more consistent behavior across string values containing integers.

Converts an XML string into a DataTable

01/21/2010 Horacio Torres

01/19/2011 Samantha Aldridge Added xml comments Added host environment value to email subject line if value is NOT production or nothing. also appended to body of email. WI 2640 01/19/2011 Justin Bailey Changed from first line to footer for the body message.

This method generates a MD5Hash of a string using the CryptoConfig.CreateFromName method of the framework.

THe string to hash. The encoding type. The computed hash.

Returns a Base64 encoded string that has been encrypted.

The string to encrypt. The encrypted string.

Returns a string using a supplied encoding that has been encrypted.

The string to encrypt. The encoding type. Returns a string using a supplied encoding that has been encrypted.

Returns a Base64 encoded string that has been decrypted.

The string to decrypt. Returns a Base64 encoded string that has been Decrypted.

Returns a string using a supplied encoding that has been decrypted.

The string to decrypt. The encoding type. Returns a string using a supplied encoding that has been decrypted.

Get the target TextBox from the specified Grid.

Target GridView Target Row Index Target Cell Index Target Control Index DirectCast Target as TextBox 01/30/2008 Justin Bailey Ported from pages. Converted to GridView objects.

Get the target CheckBox from the specified Grid.

Target GridView Target Row Index Target Cell Index Target Control Index DirectCast Target as CheckBox 01/30/2008 Justin Bailey Ported from pages. Converted to GridView objects.

Get a new table containing an optional text title row, Header control row, space row, and a Grid control row intended for the dynamic generation of a "report-like" table view used with the ExportToExcel method without affecting a host page layout.

Control to include, for example, a header table with information about the grid. Grid control to include in the content row. Optional title to be added in the first row of the new table, i.e. the "report" title. A new Table containing an optional title row, header content, and grid content in a single column with 4 or 5 rows. 02/26/2008 Justin Bailey Created. This is not the most versatile method, but it works for wrapping most controls with a table that contains a Grid, and additional information, intended for Export. It separates the UI from the export functionality by using a dynamically generated table control and provides the option of adding additional "report-like" content to the dynamic table without needing that layout on the display page.

This class was originally created in FVSCMSReports. It is being relocated here. The one in FVSCMSReports will be refactored out in the future. This is the version to use.

Reflection-based utility methods.

10/17/2005 Matt Ryavec Some helpful functions for dealing with reflection 12/02/2008 Justin Bailey Added GetAppDomainAssemblyInformation.

Compares selected properties of two PropertyInfo objects, and returns true on a full match.

10/17/2005 Matt Ryavec

Get the entry assembly (if available) and assemblies loaded into the current executing context AppDomain.

String, formatted for use in an Error Log or Email. 12/01/2008 Justin Bailey 12/17/2008 Justin Bailey Changed from using the DomainManager.

Log an exception to the given LogPath or the Enterprise ErrorLogPath, if not provided. If an error occurs while attempting to record the given exception, the error will be logged to the system's EventLog

12/01/2008 Justin Bailey Refactored to use StringBuilder and include the Assemblies loaded in the execution context of the current AppDomain. Moved file writing to after the string is built to reduce the amount of time the streamwriter is open.

This will return a versioned filename. For example, if hello.txt exists in the given directory, this method will return hello.1.txt.

05/18/2006 James Bucado

Checks the given path and filename and if it exists, appends a count with the given string format to the end of the file before the extension and returns a FullFileName (with the given path) that does not already exist on the filesystem. For example, if the file "hello.txt" already exists and the FileCountFormat is "({0})" then the value "path\hello(1).txt" will be returned.

"({0})" or any zero-based string format expression. 02/23/2009 Justin Bailey Added this overload to allow custom formats to be applied.

Moves selected items from one source list control to Target list control

Source List Box Target List Box 05/12/09 Jaya Polimati Added

Copy selected items from one source list control to Target list control

Source List Box Target List Box 05/27/09 Jaya Polimati Added

Check the Target List with source and remove any existing items that are in the source list from the target list

Source List Box Target List Box 05/09/09 Jaya Polimati Added.

Custom string matching/formatting operations.

06/10/2008 Justin Bailey Created. 'TODO: Refactor this, perhaps include the MarkMatchingKeywords method.

Take a Reg Ex match and add custom tags around it to indicate a match.

The matched string. 06/10/2008 Justin Bailey Added.

Reads the Excel file sent and pulls the VINs from the Excel file.

01/16/2004 James Fitzgerald This function reads the Excel file sent and pulls the VINs from the Excel file. 06/17/2005 Ben Richiravanich This code came from James Fitzgerald

Export a Dataset to Excel.

Object containing data to export Response object Filename with .xls 01/17/2008 Justin Bailey Added auto-disposing using statements and XML comments. Updated variables and added "Overloads" to reflect coding standard. 02/08/2008 Justin Bailey Consolidated Response calls.

Export an object to Excel. *Do not use with GridView.

Object containing data to export Response object Filename with .xls Unknown Replaced this "ByVal dgdData As DataGrid, _" with a base object to support repeater as well as datagrid. 01/17/2008 Justin Bailey Added auto-disposing using statements and XML comments. Updated variables and added "Overloads" to reflect coding standard. 02/08/2008 Justin Bailey Consolidated Response calls.

Convert a GridView into a Table so that the RenderControl method will give compatible markup.

Source GridView Table containing the GridView rows 02/08/2008 Justin Bailey Moved from ExportToExcel; originally created 01/17/2008; based in part on http://mattberseth.com/blog/2007/04/export_gridview_to_excel_1.html. Addresses "Control ... must be placed inside a form tag with runat=server" exception. Common internet solutions may indicate overriding VerifyRenderingInServerForm - do not do that.

Clear the given response and set content type and filename for ExportToExcel. Sets ContentType = "application/vnd.ms-excel".

Response object. Filename including .xls 02/08/2008 Justin Bailey Ported from each ExportToExcel method.

Write the generated HTML string to the Response stream and optionally end it (default).

Response object. String HTML output. End the Response object (default). 02/08/2008 Justin Bailey Ported from each ExportToExcel method. 03/08/2010 Samantha Aldridge Added try/catch to eat the thread abort exception thrown by response.end

Take a string and remove NonAlphaNumericCharacters

Input string. String with NonAlphaNumericCharacters removed 7/23/09 James Brooks Added

Get a comment string containing [strName] changed from [kvpOld.Value] ([kvpOld.Key]) to [kvpNew.Value] ([kvpNew.Key]) based on a Key comparison. Based on the Vehicle.GetInt/StringValueChangedString methods. Intended for situations where both the ID and string values can be visible to aid both an end user and support staff. Use: Utility.GetKeyValueChangingString("DVO Status", kvpOldStatus, kvpNewStatus) where kvpOld/New paramaters match and kvpNewStatus = New Generic.KeyValuePair(Of Integer, String)(intDVOStatusID, strDVOStatus), for example.

Typically the column name. Typically Of Int, String with ID, ColumnName 09/09/2009 Justin Bailey Added.

Converts System.Diagnostics.EventLogEntryType to LogEntryType

05/10/2010 Stanislav Kovatsenko Created

Writes log entry to the text file

05/07/2010 Stanislav Kovatsenko and James Bucado Added code to create directory if directory does not exist Added critical section to make this method thread safe

Custom VASCOR extension methods that are not specific to an application. Import Vascor.Library.Extensions to enable.

10/24/2008 Justin Bailey Added for central storage of any VASCOR custom extension methods. Works for 3.5+ codebase only. 06/13/2009 Justin Bailey Removed Overloads keyword as it is inappropriate in a Module. 08/24/2009 Justin Bailey Changed ByRef to ByVal as this was incorrectly copied from an example and not really thought through correctly when implemented here. There is no need to pass the pointer to the original object in these core method cases. Not to mention C# can't work with them that way. 05/04/2010 Justin Bailey Removed Overloads keyword to support VS 2010.

Get a value as the given Type of T from an object, but replaces DBNull or Null values with the default value of Nothing for the given Type T. Do not use this Overload with the String type if "" is expected; use the method with a ReplacementValue parameter instead.

Target Type Value or the Default Value of the given Type of T. 10/24/2008 Justin Bailey

Get a value as the given Type of T from an object, but replaces DBNull or Null values with the given tReplacementValue.

Get a value as the given Type of T from an object, but replaces DBNull, Null, or the provided ComparisonValue values with the given tReplacementValue.

Target Type Value to return if the object is DBNull or Null. Value or DefaultValue as the given Type of T. 10/24/2008 Justin Bailey http://blog.falafel.com/2006/10/17/AddingSupportForNullableTypesToTheGenericConvertDBNullToMethod.aspx This will NOT work when called as an extension method on an object in VB: http://blogs.msdn.com/vbteam/archive/2007/01/24/extension-methods-and-late-binding-extension-methods-part-4.aspx 06/06/2009 JPB: Changed DefaultValue to tReplacementValue and updated comments for clarity. 10/05/2009 James Bucado Changed Convert.ChangeType to CType because the former does not allow conversion from Integer to Nullable(Of Integer). Tried DirectCast and got the same error. So far, I only have success with CType.

Tries ToValue conversion. If does not succeed, returnes default replacement value.

Target Type The object to convert Default Replacement Value 04/28/2010 Stanislav Kovatsenko

Get a value as the given Type of T from a DataRow, but switching DBNull or Null values with the Default Value of T.

Target Type Value or DefaultValue as the given Type of T. 10/24/2008 Justin Bailey http://blog.falafel.com/2006/10/17/AddingSupportForNullableTypesToTheGenericConvertDBNullToMethod.aspx This will NOT work when called on objects in VB: http://blogs.msdn.com/vbteam/archive/2007/01/24/extension-methods-and-late-binding-extension-methods-part-4.aspx

Similar to the TSQL function IsNull, except type safe--Get a value as the given Type of T from a DataRow column, but replaces DBNull or Null values with the default value of Nothing for T. Do not use this Overload with the String type if "" is expected; use the method with a ReplacementValue parameter instead.

Get a value as the given Type of T from a DataRow, but switching DBNull or Null values with the given DefaultValue.

Target Type Value to return if the object is DBNull or Null. Column Name to retrieve. Value or DefaultValue as the given Type of T. 10/27/2008 Justin Bailey

Similar to the TSQL function IsNull, except type safe--Get a value as the given Type of T from a DataRow column, but replaces DBNull or Null values with the given tReplacementValue.

Target Type Value to return if the object is DBNull or Null. Column Name to retrieve. Value or DefaultValue as the given Type of T. 06/06/2009 Justin Bailey Same as ItemValue method, but attempting to find a good name so that it is easy for developers to use.

Get a value as the given Type of T from an SqlDataReader, but switching DBNull or Null values with the Default Value of T.

Target Type Column Name to retrieve. Value or DefaultValue as the given Type of T. 10/27/2008 Justin Bailey

Similar to the TSQL function IsNull, except type safe--Get a value as the given Type of T from a SqlDataReader, but replaces DBNull or Null values with the default value of Nothing for T. Do not use this Overload with the String type if "" is expected; use the method with a ReplacementValue parameter instead.

Target Type Column Name to retrieve. Value or DefaultValue as the given Type of T. 06/06/2009 Justin Bailey Same as ItemValue method, but attempting to find a good name so that it is easy for developers to use. 04/14/2010 James Fitzgerald Changed SqlClient.SqlDataReader to IDataReader.

Get a value as the given Type of T from a SqlDataReader, but switching DBNull or Null values with the given DefaultValue.

Target Type Value to return if the object is DBNull or Null. Column Name to retrieve. Value or DefaultValue as the given Type of T. 10/27/2008 Justin Bailey

Get a DBNull.Value if the source value is Null. The second overload should be used with Strings if String.Empty is considered Null.

10/24/2008 Justin Bailey Added.

Get a DBNull.Value if the source value is equal to the given null comparison value or the value is null.

Value to compare to in considering if the value should be returned as DBNull. 10/24/2008 Justin Bailey Added.

Get a DBNull value as the given Type of T from a DataRow if the given type is Nothing.

Target Type 01/21/2008 Justin Bailey http://blog.falafel.com/2006/10/17/AddingSupportForNullableTypesToTheGenericConvertDBNullToMethod.aspx This will NOT work when called on objects in VB: http://blogs.msdn.com/vbteam/archive/2007/01/24/extension-methods-and-late-binding-extension-methods-part-4.aspx

Get a DBNull value as the given Type of T from a DataRow if the given type is Nothing or it is equal to the given NullComparisonValue.

Target Type Value to compare against to qualify for returning DBNull. Column Name to retrieve. 01/21/2008 Justin Bailey

This method will return a Date value of some sort.

Either DateTime.MinValue if the string is not a valid date or the string expressed as a date object. Patrick Johnson 3/15/2009

Get a value as the given Type of T from a string value, but replacing DBNull or Null values with the default value of the given Type T, e.g. if a string value of "" is passed in and (Of Integer) is specified, 0 will be returned as an Integer. This will allow for strongly typing String based Win/Web Forms such as DropDownList.SelectedValue or TextBox.Text values when passed into the BO or DA layers that are correctly using typed parameters.

Target Type Value or the Default Value of the given Type of T. 03/20/2009 Justin Bailey 06/06/2009 JPB: Changed DefaultValue to tReplacementValue and updated comments for clarity.

03/20/2009 Justin Bailey 06/06/2009 JPB: Changed DefaultValue to tReplacementValue and updated comments for clarity.

03/20/2009 Justin Bailey Using the new FromXYZ suggested by James Brooks. Aiming to address the problem of WebForm controls typically being String typed and needing to get into the intended type wihtout IIF or IF statements. 06/06/2009 JPB: Changed DefaultValue to tReplacementValue and updated comments for clarity.

Pass in the EDI segment string, the starting position of the part you want to look for and the length of that part. If the segment is missing that part, then send back nothing. Zero based.

Beginning position in the segment to parse. Maximum Length of the field to be parsed 10/28/2009 James Fitzgerald Created. Pulled from my Ford Dealer Import in C#. I'll admit that Brooks came up with this idea first, but I didn't know it when I created mine. Neither one of our functions were in the library. Now it is. 10/28/2009 16:48 James Fitzgerald Moved from utility and changed name from SubstringEDISegment.

Returns a table as XML string

Horacio Torres 01/21/2010 Copied from StasLib and renamed to GetXML

01/21/2010 Horacio Torres Copied to modExtensions an renamed to GetXML Adding Obsolete atribute