Vascor.UI.Web.Library

Base FVSCMS GridView with column Sorting indicators and Paging validation. Private Sub... Handles grdVINs.Sorting ... If Not IsNothing(currentView) Then currentView.Sort = grdVINs.SortValue grdVINs.PageIndex = 0 grdVINs.DataBind() End If ...

01/17/2008 Justin Bailey Ported from FVSCMSGrid; included pseudo multi-column sorting; paging only needs to be rebound on PageIndexChanging

Get a new instance of an FVSCMS GridView.

01/18/2008 Justin Bailey Added EmptyDataText default value. 07/28/2008 Removed PagerSettings.Visible=False and all explicit style values--use the CSS class instead. Added default CSSClasses instead of explicit styles.

Gets or sets a value indicating whether user-defined styles will be used or pre-defined ones. Default is False so that standard CSS styles will be applied to the control. True will set the control CssClass and default in-line styles for all children elements which can easily be overriden by a user-defined style or CssClass.

07/31/2008 Justin Bailey Added.

Gets or sets a value indicating whether a click event for the RowOnClickCommand call is automatically added for each Data Row.

true to automatically add a row onclick event for each data row; otherwise, false. The default is false. 04/04/2008 Justin Bailey Created.

Gets or sets the GridView command name to be executed on Row Click. Default value is "Select."

String value representing the command name to be executed. 04/07/2008 Justin Bailey Added.

Gets or sets a value indicating if the current data is sorted in Ascending order

True if Ascending 01/16/2008 Justin Bailey Ported from the existing FVSCMSGrid Leaving the object type so that the boolean won't default to False

Gets or sets the expression used to sort the items in the GridView control.

The expression used to sort the items in the GridView control. Supports multiple columns separated by commas in Grids that explicitly handle the Sorting event. 01/16/2008 Justin Bailey Ported from the existing FVSCMSGrid

Gets or sets the sort column(s) and sort order for the current data based on the SortExpression and SortDirection.

A string that contains the column name(s) followed by "ASC" (ascending) or "DESC" (descending). Columns are sorted ascending by default. Multiple columns can be separated by commas. 01/16/2008 Justin Bailey Created *Requires BuildSort and ViewState("Sort") Allow for future multi-column select yet keeps legacy compatibility with leaving the built in SortExpression alone

Returns a comma delimited string of field names and adds sort direction for a full sort expression

Comma delimited field list A comma delimited string of field names with sort direction ASC or DESC 01/16/2008 Justin Bailey Ported from page code-behind to reduce amount of page-side coding 08/06/2009 Justin Bailey Added ASC append. Added IsNullOrEmpty check.

Occurs when a row is created in a System.Web.UI.WebControls.GridView control.

01/16/2008 Justin Bailey Ported from FVSCMSGrid Removed sorted cell clear and re-add of link and label controls *Requires Property IsSortedAscending 03/05/2008 Justin Bailey Refactored to consolidate IFs and be compatible with all DataSources by completing the conversion to all GridView members. 07/30/2008 Justin Bailey Added CssClass and Asc/Desc styles. 08/06/2009 JPB: Changed from StartsWith to Array Contains and added ToUpper. 'TODO: Ammend the "all fields or nothing" for the IsSortedAscending property.

Occurs when the hyperlink to sort a column is clicked, but before the System.Web.UI.WebControls.GridView control handles the sort operation.

01/16/2008 Justin Bailey Ported from FVSCMSGrid *Requires Properties IsSortedAscending and SortExpression

Occurs when one of the pager buttons is clicked, but before the System.Web.UI.WebControls.GridView control handles the paging operation. *Grid needs only to be bound to the datasource--page index changing operations are already handled in addition to validation on the Index. Private Sub... Handles grdVINs.PageIndexChanging ReBindGrid() End Sub

RMB: 8-14-07 Wrapped the CurrentPageIndex assignment with a condition to prevent a random assignment error from occurring Could log the e.NewPageIndex to identify the value being assigned and cause this type of error; For now, just set the page index to the first page. 01/16/2008 Justin Bailey Ported from FVSCMSGrid

Occurs when a data row is bound to data in a System.Web.UI.WebControls.GridView control. Adds the full row click Select event scripts if the Property value is true.

04/04/2008 Justin Bailey Created. 07/22/2008 Justin Bailey Removed the RowClick code from being added for the EditRow.

Occurs when a row's Select button is clicked, but before the System.Web.UI.WebControls.GridView control handles the select operation. Adds deselect if the selected row is clicked twice while AutoGenerateRowOnClick is enabled.

FVSCMS Handle Exception will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge Added override per email from Justin Bailey

Standardized means of handling an exception in the application. FVSCMS Handle excpetion will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge override created per email from Justin Bailey

07/16/2010 Samantha Aldridge Modified added appending the host environment if it's not already on the title

Builds a GoogleAnalytics Tracking Code string without javascript tags.

2011-03-29 Justin Bailey

Calls RunJavaScript using the script itself as the key

Content of the script that will be sent to the client. Also functions as the Key in this case. 09/21/2005 Matt Ryavec Calls RunJavaScript using the script itself as the key

Use this to emit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block. 02/08/2008 Justin Bailey Added type to client-side text for XHTML compliance.

Use this to emmit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block.

displays a message box to the screen

12/31/2012 Samantha Aldridge Not original author, changing implementation from VBScript to Javascript for cross browser compatibility WI

Rudimentary helper function to convert between vb msg box and javascript alert type

12/31/2012 Samantha Aldridge Created WI 7954

Standardized means of handling an exception in the application.

01/18/2005 Patrick Johnson Standardized means of handling an exception in the application.

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey 04/18/2012 Samantha Aldridge making public

Export datagrid or repeater to excel

Target Grid or Repeater as Object Target File Name 08/24/2005 Maaloot Suprawan This function wrote by Yogesh Agrawal Export datagrid or repeater to excel

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** 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.

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** 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.

Redirects via client startup script.

window.open(strTargetURL,--) window.open(--,strTarget) 09/09/2009 Justin Bailey

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey

Gets a simple DataSet and DataTable called "WebServiceMessage" containing a Row and Column called "Message" to wrap a string value to return to the caller.

08/28/2008 Justin Bailey Added.

Gets a DataTable called "Exception" with a row and two columns called "ExceptionMessage" and "Exception" which will contain the ex.Message and ex, respectively.

08/28/2008 Justin Bailey Added.

Appends an ExceptionTable to a given DataSet or if it exists, appends a new exception row to the Exception table.

Send Nothing to use ex.Message. Send Nothing to omit. Required. 08/28/2008 Justin Bailey Added.

This is used to return the application name from the web.config Was first used to split the database for Logistics and LogisticsMexico

ApplicationName 3/26/10 James Brooks Created ****************** NOTE ****************** MUST EXIST IN THE WEB.CONFIG FOR THE APPLICATION ****************** NOTE ****************** '''

Converts text values for controls, server and client side strings.

Reference to the calling page. Page ID as listed in tbPage. Hashtable of all Server side strings. Hashtable of all Client side strings Boolean success or failure status. Looking to factor Page ID into the Page object.

if the key is in machine config return it, else does NOT throw an exception Returns empty string

07/07/2010 Samantha Aldridge Created 08/03/2010 Samantha Aldridge added isoptional=true in case other apps use this page

Gets the ReportServerURL for the application Report Server. Checks for that key in the AppSettings or the Application Configuration section if the Machine.Config.SectionName key is defined (in the AppSettings).

12/22/2009 Justin Bailey Added to support SSRS.

Custom implimentation of the ClientScript / Page method that Registers the startup script with the current System.Web.UI.Page object type, a key, and a script literal; unless a ScriptManager is present, which takes precedence in receiving the Registration for AJAX support.

A unique identifier for the script block. The script. 09/04/2008 Justin Bailey Added to centralize multiple calls with the same pattern as well as support AJAX ScriptManagers.

Custom implimentation of the ClientScript / Page method that Registers the startup script with the current System.Web.UI.Page object type, a key, a script literal, and a Boolean value indicating whether to add script tags; unless a ScriptManager is present, which takes precedence in receiving the Registration for AJAX support.

A unique identifier for the script block. The script. true to enclose the script block with tags; otherwise, false. 09/04/2008 Justin Bailey Added to centralize multiple calls with the same pattern as well as support AJAX ScriptManagers.

Supply Chain Accounting

12/2013 Samantha Aldridge created

FVSCMS Handle Exception will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge Added override per email from Justin Bailey

Standardized means of handling an exception in the application. FVSCMS Handle excpetion will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge override created per email from Justin Bailey

07/16/2010 Samantha Aldridge Modified added appending the host environment if it's not already on the title

Builds a GoogleAnalytics Tracking Code string without javascript tags.

2011-03-29 Justin Bailey

Calls RunJavaScript using the script itself as the key

Content of the script that will be sent to the client. Also functions as the Key in this case. 09/21/2005 Matt Ryavec Calls RunJavaScript using the script itself as the key

Use this to emit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block. 02/08/2008 Justin Bailey Added type to client-side text for XHTML compliance.

Use this to emmit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block.

displays a message box to the screen

12/31/2012 Samantha Aldridge Not original author, changing implementation from VBScript to Javascript for cross browser compatibility WI

Rudimentary helper function to convert between vb msg box and javascript alert type

12/31/2012 Samantha Aldridge Created WI 7954

Standardized means of handling an exception in the application.

01/18/2005 Patrick Johnson Standardized means of handling an exception in the application.

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey 04/18/2012 Samantha Aldridge making public

Export datagrid or repeater to excel

Target Grid or Repeater as Object Target File Name 08/24/2005 Maaloot Suprawan This function wrote by Yogesh Agrawal Export datagrid or repeater to excel

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export a Dataset to Excel.

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export an object to Excel. *Do not use with GridView.

Redirects via client startup script.

window.open(strTargetURL,--) window.open(--,strTarget) 09/09/2009 Justin Bailey

Master page class created for fvscms classic website's ui redesign.

08/15/2014 Samantha Aldridge Created.

Enforce that the context page type be of an FVSCMSUIPage so that the implemented master page has access to the fvscms page's security and viewstate methods.

10/09/2013 Samantha Aldridge Created

Master page class created for fvscms classic website's ui redesign.

12/16/2013 Samantha Aldridge Created.

Enforce that the context page type be of an FVSCMSUIPage so that the implemented master page has access to the fvscms page's security and viewstate methods.

10/09/2013 Samantha Aldridge Created

Supply Chain Accounting

12/2013 Samantha Aldridge created

FVSCMS Handle Exception will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge Added override per email from Justin Bailey

Standardized means of handling an exception in the application. FVSCMS Handle excpetion will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge override created per email from Justin Bailey

07/16/2010 Samantha Aldridge Modified added appending the host environment if it's not already on the title

Builds a GoogleAnalytics Tracking Code string without javascript tags.

2011-03-29 Justin Bailey

Calls RunJavaScript using the script itself as the key

Content of the script that will be sent to the client. Also functions as the Key in this case. 09/21/2005 Matt Ryavec Calls RunJavaScript using the script itself as the key

Use this to emit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block. 02/08/2008 Justin Bailey Added type to client-side text for XHTML compliance.

Use this to emmit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block.

displays a message box to the screen

12/31/2012 Samantha Aldridge Not original author, changing implementation from VBScript to Javascript for cross browser compatibility WI

Rudimentary helper function to convert between vb msg box and javascript alert type

12/31/2012 Samantha Aldridge Created WI 7954

Standardized means of handling an exception in the application.

01/18/2005 Patrick Johnson Standardized means of handling an exception in the application.

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey 04/18/2012 Samantha Aldridge making public

Export datagrid or repeater to excel

Target Grid or Repeater as Object Target File Name 08/24/2005 Maaloot Suprawan This function wrote by Yogesh Agrawal Export datagrid or repeater to excel

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export a Dataset to Excel.

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export an object to Excel. *Do not use with GridView.

Redirects via client startup script.

window.open(strTargetURL,--) window.open(--,strTarget) 09/09/2009 Justin Bailey

11/02/2012 Samantha Aldridge added loadingpanel javascript function call for fvscms menu items. 03/20/2013 Samantha Aldridge changed call for onclick to load menu items js function (fvscms applicationID only) WI 9370

Returns the value in machine config, if value not there does NOT throw exception it will return empty string

07/07/2010 Samantha Aldridge Created

This will set the PageCode and set the corresponding PageID for the given PageCode and ApplicationCode

PageCode 8/16/10 James Brooks WI 1811 Created This is setting the PageID for legacy applications to save a round trip to the server.

This will get the PageID The value is setup through the PageCode property

PageID 8/16/10 James Brooks WI 1811 Created This is set from the PageCode property for legacy applications to save a round trip to the server.

12/22/2009 Justin Bailey Added to support SSRS.

Standardized means of handling an exception in the application.

01/18/2005 Patrick Johnson 08/25/2009 Justin Bailey Added XML comments. Removed optional param and added Overloads. 11/30/2010 Samantha Aldridge added in overridable 08/06/2012 Samantha Aldridge checking for inner exception to add to the message

Standardized means of handling an exception in the application.

08/25/2009 Justin Bailey Added overload with ByVAL ex and the default value as formerly defined in the original method's optional parameter.

12/28/2012 Changing to use javascript instead of vbscript for cross browser support

07/16/2010 Samantha Aldridge Modified added appending the host environment if it's not already on the title

A unique identifier for the script block. The script. 09/04/2008 Justin Bailey Added to centralize multiple calls with the same pattern as well as support AJAX ScriptManagers.

Gets the full redirect URL string, taking into account a full URL in the config file.

2011-03-22 Justin Bailey Created to one, consolidate code, and two, include the option to override the virtual directory. 11/10/2011 Samantha Aldridge changed from private to protected so inherited classes can call.(ie for top menu logoff link)

returns the url for the security error page which displays the access denied error at this time, can be extended to send an error code for additional messages.

12/08/2014 Samantha Aldridge Created WI 16884

This property is used to switch on/off the persist viewstate to file feature.

This property is useful for debugging. If you do not want the viewstate persisted then do not inherit this class since that is all it does.

This Method is used to Save the Viewstate values of the controls on the page into the specified file.

This Function loads the persisted Viewstate values from the file on to the controls.

This Property is used to create and retrieve the viewstate filename.

Clean up files older than N days old. This method should only be used when your sites session times out at a different intreval than the ASP.Net session.

This method should only be used when your sites session times out at a different intreval than the ASP.Net session.

This Shared Method is used to delete the Viewstate files for a session.

Reference to a session object, typically passed in by the Session_End Event in the Global.asax.

This property is used to create and return the path and filename of the viewstate file.

This property will return the viewstate file guid query string key.

This property is used to create and return the ViewStateFilePath.

Gets or sets the current assembly type as defined by the initializer. Intended for use with the method call.

08/03/2009 Justin Bailey

Get the current assembly version of the initializing class dll. Typically used for testing connectivity to the Web Service by calling String.IsNullOrEmpty on the return value. Requires that the property be set.

08/03/2009 Justin Bailey

Base WS class for anything Casper.

02/02/2009 Justin Bailey Moved some the base GetFilename methods here and added a base ForwardScannerData

Gets the value of the header table used for scanner datasets. Needs to match the relevant value in the mobile code.

01/15/2009 Justin Bailey

Gets the value of the header table used for scanner datasets. Needs to match the relevant value in the mobile code.

01/15/2009 Justin Bailey

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey

Writes the standard Casper header table to the given hash table as parameters for use with Vascor SQLData.

01/15/2009 Justin Bailey 02/23/2011 Horacio Torres Inspector1 renamed to Operator WI 2720

Get the Casper Data directory and create it if it does not exist.

02/01/2009 Justin Bailey

Get the Casper BadFile directory and create it if it does not exist.

01/07/2009 Justin Bailey 02/02/2009 Justin Bailey Moved from CasperWSHQ.

Receive a dataset containing the scanner data raw file. Returns 1 if the file was saved successfully or 0 if there was a problem and the file should be preserved at the caller.

0 or less for failure. 1 or greater for success. 02/01/2009 Justin Bailey TODO: JPB: 1) Make this support business lines OR 2) Support override per business line. Either way, the intended use needs to be made clear. 02/03/2009 Justin Bailey Changed return type to Integer to match other implementations that may return the StageID for success.

This is used to return the application name from the web.config Was first used to split the database for Logistics and LogisticsMexico

ApplicationName 3/26/10 James Brooks Created

FVSCMS Handle Exception will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge Added override per email from Justin Bailey

Standardized means of handling an exception in the application. FVSCMS Handle excpetion will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge override created per email from Justin Bailey

07/16/2010 Samantha Aldridge Modified added appending the host environment if it's not already on the title

Builds a GoogleAnalytics Tracking Code string without javascript tags.

2011-03-29 Justin Bailey

Calls RunJavaScript using the script itself as the key

Content of the script that will be sent to the client. Also functions as the Key in this case. 09/21/2005 Matt Ryavec Calls RunJavaScript using the script itself as the key

Use this to emit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block. 02/08/2008 Justin Bailey Added type to client-side text for XHTML compliance.

Use this to emmit any javascript to run on page load.

Content of the script that will be sent to the client. Unique key that identifies the script block.

displays a message box to the screen

12/31/2012 Samantha Aldridge Not original author, changing implementation from VBScript to Javascript for cross browser compatibility WI

Rudimentary helper function to convert between vb msg box and javascript alert type

12/31/2012 Samantha Aldridge Created WI 7954

Standardized means of handling an exception in the application.

01/18/2005 Patrick Johnson Standardized means of handling an exception in the application.

Gets a value from the custom Application Settings. Use instead of ConfigurationManager.AppSettings. Implements .

AppSettings Key. Value of the key if found or an exception. 11/25/2008 Justin Bailey 04/18/2012 Samantha Aldridge making public

Export datagrid or repeater to excel

Target Grid or Repeater as Object Target File Name 08/24/2005 Maaloot Suprawan This function wrote by Yogesh Agrawal Export datagrid or repeater to excel

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export a Dataset to Excel.

**DEPRECATED. Use Vascor.Library.Utility.ExportToExcel** Export an object to Excel. *Do not use with GridView.

Redirects via client startup script.

window.open(strTargetURL,--) window.open(--,strTarget) 09/09/2009 Justin Bailey

Master page class created for fvscms classic website's ui redesign.

04/17/2012 Samantha Aldridge Created.

Enforce that the context page type be of an FVSCMSUIPage so that the implemented master page has access to the fvscms page's security and viewstate methods.

04/17/2012 Samantha Aldridge Created

FVSCMS/OMS Handle Exception will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge Added override per email from Justin Bailey 03/28/2012 TFS: 9574 Justin Pierson Migrated to OMSUIPage

Standardized means of handling an exception in the application. FVSCMS/OMS Handle excpetion will ignore ThreadAbortExceptions , write them to the output window

11/30/2010 Samantha Aldridge override created per email from Justin Bailey 03/28/2012 TFS: 9574 Justin Pierson Migrated to OMSUIPage

06/02/2011 Samantha Aldridge changed for loop to start at the beginning of the array, it was missing the first element so the password check was only happening against the current password, not the one before

This method takes a userID and calls okToChangePassword(Guid userID, string password) using the password property for the second parameter.

Pass/Fail

Master page class created for fvscms classic website's ui redesign.

10/09/2013 Samantha Aldridge Created.

Enforce that the context page type be of an FVSCMSUIPage so that the implemented master page has access to the fvscms page's security and viewstate methods.

10/09/2013 Samantha Aldridge Created

Custom VASCOR extension methods that are not specific to an application but specifically targeted to UI.Web. Import Vascor.UI.Web.Library.Extensions to enable.

10/13/2008 Justin Bailey Added for central storage of any VASCOR custom extension methods for UI Web. Works for 3.5 codebase only.

If the given control exists and contains the target CssClass name, it will be removed from the target control's existing CssClass(es). 1) lblMyLable.CssClass = "CustomLabelClass Required minWidth" 2) lblMyLabel.RemoveCssClass("Required") 3) lblMyLable.CssClass.ToString() will equal "CustomLabelClass minWidth"

10/13/2008 Justin Bailey Added to mimick the built-in AJAX functionality.

If the target control exists and does not contain the given CssClass name, it will be added to the target control at the end of any existing CssClass names. 1) lblMyLable.CssClass = "CustomLabelClass minWidth" 2) lblMyLabel.AddCssClass("Required") 3) lblMyLable.CssClass.ToString() will equal "CustomLabelClass minWidth Required"

10/13/2008 Justin Bailey Added to mimick the built-in AJAX functionality.

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.