cudreg-saml2/App_Code/Shared/BaseApplicationTableControl.vb
2025-06-08 16:22:20 +07:00

531 lines
27 KiB
VB.net

Imports BaseClasses
Imports BaseClasses.Data
Imports BaseClasses.Utils.StringUtils
Namespace Persons.UI
' Typical customizations that may be done in this class include
' - adding custom event handlers
' - overriding base class methods
''' <summary>
''' The superclass (i.e. base class) for all Designer-generated pages in this application.
''' </summary>
''' <remarks>
''' <para>
''' </para>
''' </remarks>
Public Class BaseApplicationTableControl
Inherits System.Web.UI.Control
''' <summary>
''' The name of the row controls. By convention, "Row" is appended to the
''' end of the name of the table control. So OrdersTableControl will have
''' OrdersTableControlRow controls.
''' </summary>
Public Overridable ReadOnly Property RowName() As String
Get
Return Me.ID & "Row"
End Get
End Property
''' <summary>
''' The name of the repeater controls. By convention, "Repeater" is appended to the
''' end of the name of the table control. So OrdersTableControl will have
''' OrdersTableControlRepeater controls. The Row controls defined above are
''' within the Repeater control.
''' </summary>
Public Overridable ReadOnly Property RepeaterName() As String
Get
Return Me.ID & "Repeater"
End Get
End Property
''' Allow for migration from earlier versions which did not have url encryption.
Public Overridable Function ModifyRedirectUrl(ByVal redirectUrl As String, ByVal redirectArgument As String) As String
Throw New Exception("This function should be implemented by inherited table control class.")
End Function
Public Overridable Function ModifyRedirectUrl(ByVal redirectUrl As String, ByVal redirectArgument As String, ByVal bEncrypt As Boolean) As String
Throw New Exception("This function should be implemented by inherited table control class.")
End Function
Public Overridable Function EvaluateExpressions(ByVal redirectUrl As String, ByVal redirectArgument As String, ByVal bEncrypt As Boolean) As String
Throw New Exception("This function should be implemented by inherited table control class.")
End Function
''' Allow for migration from earlier versions which did not have url encryption.
Public Overridable Function ModifyRedirectUrl(ByVal redirectUrl As String, ByVal redirectArgument As String, ByVal rec As IRecord) As String
Return EvaluateExpressions(redirectUrl, redirectArgument, rec, False)
End Function
Public Overridable Function ModifyRedirectUrl(ByVal redirectUrl As String, ByVal redirectArgument As String, ByVal rec As IRecord, ByVal bEncrypt As Boolean) As String
Return EvaluateExpressions(redirectUrl, redirectArgument, rec, bEncrypt)
End Function
Public Overridable Function EvaluateExpressions(ByVal redirectUrl As String, ByVal redirectArgument As String, ByVal rec As IRecord, ByVal bEncrypt As Boolean) As String
Const PREFIX_NO_ENCODE As String = "NoUrlEncode:"
Dim finalRedirectUrl As String = redirectUrl
Dim finalRedirectArgument As String = redirectArgument
If (finalRedirectUrl Is Nothing OrElse finalRedirectUrl.Trim = "") Then
Return finalRedirectUrl
ElseIf (finalRedirectUrl.IndexOf("{"c) < 0) Then
Return finalRedirectUrl
Else
'The old way was to pass separate URL and arguments and use String.Format to
'do the replacement. Example:
' URL: EditProductsRecord?Products={0}
' Argument: PK
'The new way to is pass the arguments directly in the URL. Example:
' URL: EditProductsRecord?Products={PK}
'If the old way is passsed, convert it to the new way.
If (Len(finalRedirectArgument) > 0) Then
Dim arguments() As String = Split(finalRedirectArgument, ",")
Dim i As Integer
For i = 0 To (arguments.Length - 1)
finalRedirectUrl = finalRedirectUrl.Replace("{" & i.ToString & "}", "{" & arguments(i) & "}")
Next
finalRedirectArgument = ""
End If
'Evaluate all of the expressions in the RedirectURL
'Expressions can be of the form [ControlName:][NoUrlEncode:]Key[:Value]
Dim remainingUrl As String = finalRedirectUrl
While (remainingUrl.IndexOf("{"c) >= 0) And (remainingUrl.IndexOf("}"c) > 0) And _
(remainingUrl.IndexOf("{"c) < remainingUrl.IndexOf("}"c))
Dim leftIndex As Integer = remainingUrl.IndexOf("{"c)
Dim rightIndex As Integer = remainingUrl.IndexOf("}"c)
Dim expression As String = remainingUrl.Substring(leftIndex + 1, rightIndex - leftIndex - 1)
Dim origExpression As String = expression
remainingUrl = remainingUrl.Substring(rightIndex + 1)
Dim skip As Boolean = False
Dim returnEmptyStringOnFail As Boolean = False
Dim prefix As String = Nothing
'Check to see if this control must evaluate the expression
If (expression.IndexOf(":") > 0) Then
prefix = expression.Substring(0, expression.IndexOf(":"))
End If
If (Not IsNothing(prefix)) AndAlso (prefix.Length > 0) AndAlso _
(Not (InvariantLCase(prefix) = InvariantLCase(PREFIX_NO_ENCODE))) AndAlso _
(Not BaseRecord.IsKnownExpressionPrefix(prefix)) Then
'Remove the ASCX Prefix
Dim IdString As String = Me.ID
If IdString.StartsWith("_") Then
IdString = IdString.Remove(0, 1)
End If
'The prefix is a control name.
If (prefix = IdString) Then
'This control is responsible for evaluating the expression,
'so if it can't be evaluated then return an empty string.
returnEmptyStringOnFail = True
expression = expression.Substring(expression.IndexOf(":") + 1)
Else
'It's not for this control to evaluate so skip.
skip = True
End If
End If
If (Not skip) Then
Dim bUrlEncode As Boolean = True
If (InvariantLCase(expression).StartsWith(InvariantLCase(PREFIX_NO_ENCODE))) Then
bUrlEncode = False
expression = expression.Substring(PREFIX_NO_ENCODE.Length)
End If
Dim result As Object = Nothing
Try
If (Not IsNothing(rec)) Then
result = rec.EvaluateExpression(expression)
End If
Catch ex As Exception
'Fall through
End Try
If (Not IsNothing(result)) Then
result = result.ToString()
End If
If (IsNothing(result)) Then
If (Not returnEmptyStringOnFail) Then
Return finalRedirectUrl
Else
result = String.Empty
End If
End If
If (bUrlEncode) Then
result = System.Web.HttpUtility.UrlEncode(DirectCast(result, String))
If (IsNothing(result)) Then
result = String.Empty
End If
End If
If (bEncrypt) Then
If Not (IsNothing(result)) Then
result = DirectCast(Me.Page, BaseApplicationPage).Encrypt(DirectCast(result, String))
End If
End If
finalRedirectUrl = finalRedirectUrl.Replace("{" & origExpression & "}", DirectCast(result, String))
End If
End While
End If
'If there are still expressions to evaluate. Forward to the page for further processing.
Return finalRedirectUrl
End Function
Public Function AreAnyUrlParametersForMe(ByVal url As String, ByVal arg As String) As Boolean
Const PREFIX_NO_ENCODE As String = "NoUrlEncode:"
Dim finalRedirectUrl As String = url
Dim finalRedirectArgument As String = arg
If (Len(finalRedirectArgument) > 0) Then
Dim arguments() As String = Split(finalRedirectArgument, ",")
Dim i As Integer
For i = 0 To (arguments.Length - 1)
finalRedirectUrl = finalRedirectUrl.Replace("{" & i.ToString & "}", "{" & arguments(i) & "}")
Next
finalRedirectArgument = ""
End If
'Evaluate all of the expressions in the RedirectURL
'Expressions can be of the form [ControlName:][NoUrlEncode:]Key[:Value]
Dim remainingUrl As String = finalRedirectUrl
Dim skip As Boolean = False
While (remainingUrl.IndexOf("{"c) >= 0) And (remainingUrl.IndexOf("}"c) > 0) And _
(remainingUrl.IndexOf("{"c) < remainingUrl.IndexOf("}"c))
Dim leftIndex As Integer = remainingUrl.IndexOf("{"c)
Dim rightIndex As Integer = remainingUrl.IndexOf("}"c)
Dim expression As String = remainingUrl.Substring(leftIndex + 1, rightIndex - leftIndex - 1)
Dim origExpression As String = expression
remainingUrl = remainingUrl.Substring(rightIndex + 1)
Dim returnEmptyStringOnFail As Boolean = False
Dim prefix As String = Nothing
'Check to see if this control must evaluate the expression
If (expression.IndexOf(":") > 0) Then
prefix = expression.Substring(0, expression.IndexOf(":"))
End If
If (Not IsNothing(prefix)) AndAlso (prefix.Length > 0) AndAlso _
(Not (InvariantLCase(prefix) = InvariantLCase(PREFIX_NO_ENCODE))) AndAlso _
(Not BaseRecord.IsKnownExpressionPrefix(prefix)) Then
'The prefix is a control name.
If (prefix = Me.ID) Then
skip = False
Exit While
Else
'It's not for this control to evaluate so skip.
skip = True
End If
End If
End While
If skip Then
Return False
End If
Return True
End Function
#Region " Methods to manage saving and retrieving control values to session. "
Protected Sub Control_SaveControls_Unload(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Unload
If DirectCast(Me.Page, BaseApplicationPage).ShouldSaveControlsToSession Then
Me.SaveControlsToSession()
End If
End Sub
Protected Overridable Sub SaveControlsToSession()
End Sub
Protected Sub Control_ClearControls_PreRender(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.PreRender
Me.ClearControlsFromSession()
End Sub
Protected Overridable Sub ClearControlsFromSession()
End Sub
Public Sub SaveToSession( _
ByVal control As Control, _
ByVal value As String)
SaveToSession(control.UniqueID, value)
End Sub
Public Function GetFromSession( _
ByVal control As Control, _
ByVal defaultValue As String) As String
Return GetFromSession(control.UniqueID, defaultValue)
End Function
Public Function GetFromSession(ByVal control As Control) As String
Return GetFromSession(control.UniqueID, Nothing)
End Function
Public Sub RemoveFromSession(ByVal control As Control)
RemoveFromSession(control.UniqueID)
End Sub
Public Function InSession(ByVal control As Control) As Boolean
Return InSession(control.UniqueID)
End Function
Public Sub SaveToSession( _
ByVal control As Control, _
ByVal variable As String, _
ByVal value As String)
SaveToSession(control.UniqueID & variable, value)
End Sub
Public Function GetFromSession( _
ByVal control As Control, _
ByVal variable As String, _
ByVal defaultValue As String) As String
Return GetFromSession(control.UniqueID & variable, defaultValue)
End Function
Public Sub RemoveFromSession( _
ByVal control As Control, _
ByVal variable As String)
RemoveFromSession(control.UniqueID & variable)
End Sub
Public Function InSession( _
ByVal control As Control, _
ByVal variable As String) As Boolean
Return InSession(control.UniqueID & variable)
End Function
Public Sub SaveToSession( _
ByVal name As String, _
ByVal value As String)
Me.Page.Session()(GetValueKey(name)) = value
End Sub
Public Function GetFromSession( _
ByVal name As String, _
ByVal defaultValue As String) As String
Dim value As String = CType(Me.Page.Session()(GetValueKey(name)), String)
If value Is Nothing OrElse value.Trim() = "" Then
value = defaultValue
End If
Return value
End Function
Public Function GetFromSession(ByVal name As String) As String
Return GetFromSession(name, Nothing)
End Function
Public Sub RemoveFromSession(ByVal name As String)
Me.Page.Session.Remove(GetValueKey(name))
End Sub
Public Function InSession(ByVal name As String) As Boolean
Return (Not Me.Page.Session(GetValueKey(name)) Is Nothing)
End Function
Public Function GetValueKey(ByVal name As String) As String
Return Me.Page.Session.SessionID & Me.Page.AppRelativeVirtualPath & name
End Function
#End Region
''' <summary>
''' This function returns the list of record controls within the table control.
''' There is a more specific GetRecordControls function generated in the
''' derived classes, but in some cases, we do not know the specific type of
''' the table control, so we need to call this method. This is also used by the
''' Formula evaluator to perform Sum, Count and CountA functions.
''' </summary>
Public Function GetBaseRecordControls() As BaseApplicationRecordControl()
Dim recList As ArrayList = New ArrayList()
' First get the repeater inside the Table Control.
Dim rep As System.Web.UI.WebControls.Repeater = CType(Me.FindControl(Me.RepeaterName), System.Web.UI.WebControls.Repeater)
If IsNothing(rep) OrElse IsNothing(rep.Items) Then Return Nothing
' We now go inside the repeater to find all the record controls.
' Note that we only find the first level record controls. We do not
' descend down and find other record controls belonging to tables-inside-table.
Dim repItem As System.Web.UI.WebControls.RepeaterItem
For Each repItem In rep.Items
Dim recControl As BaseApplicationRecordControl = DirectCast(repItem.FindControl(Me.RowName), BaseApplicationRecordControl)
If Not (IsNothing(recControl)) Then recList.Add(recControl)
Next
Return DirectCast(recList.ToArray(GetType(BaseApplicationRecordControl)), BaseApplicationRecordControl())
End Function
''' <summary>
''' Sum the values of the displayed controls. The controlName must be
''' a textbox, label or literal.
''' This function is called as [Products]TableControl.SUM("UnitPrice").
''' To make sure all the formula functions are in the same location, we call
''' the SUM function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total of adding the value contained in each of the fields.</returns>
Public Function Sum(ByVal controlName As String) As Decimal
Return FormulaUtils.Sum(Me, controlName)
End Function
''' <summary>
''' Sum the values of the displayed controls. The controlName must be
''' a textbox, label or literal.
''' This function is called as [Products]TableControl.TOTAL("UnitPrice").
''' To make sure all the formula functions are in the same location, we call
''' the TOTAL function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total of adding the value contained in each of the fields.</returns>
Public Function Total(ByVal controlName As String) As Decimal
Return FormulaUtils.Total(Me, controlName)
End Function
''' <summary>
''' Finds the maximum among the values of the displayed controls. The ctlName must be
''' a textbox, label or literal.
''' This function should be called as [Products]TableControl.Max("UnitPrice"), not
''' as shown here. The MAX function in the BaseApplicationTableControl will call this
''' function to actually perform the work - so that we can keep all of the formula
''' functions together in one place.
''' </summary>
''' <param name="ctlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The maximum among the values contained in each of the fields.</returns>
Public Function Max(ByVal ctlName As String) As Decimal
Return FormulaUtils.Max(Me, ctlName)
End Function
''' <summary>
''' Finds the minimum among the values of the displayed controls. The ctlName must be
''' a textbox, label or literal.
''' This function should be called as [Products]TableControl.Min("UnitPrice"), not
''' as shown here. The MIN function in the BaseApplicationTableControl will call this
''' function to actually perform the work - so that we can keep all of the formula
''' functions together in one place.
''' </summary>
''' <param name="ctlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The minimum among the values contained in each of the fields.</returns>
Public Function Min(ByVal ctlName As String) As Decimal
Return FormulaUtils.Min(Me, ctlName)
End Function
''' <summary>
''' Count the number of rows in the table control.
''' This function is called as [Products]TableControl.COUNT().
''' To make sure all the formula functions are in the same location, we call
''' the COUNT function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <returns>The total number of rows in the table control.</returns>
Public Function Count(ByVal controlName As String) As Decimal
Return FormulaUtils.Count(Me, controlName)
End Function
''' <summary>
''' Count the number of rows in the table control that are non-blank.
''' This function is called as [Products]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the COUNTA function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function CountA(ByVal controlName As String) As Decimal
Return FormulaUtils.CountA(Me, controlName)
End Function
''' <summary>
''' Mean of the rows in the table control.
''' This function is called as [Product]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the MEAN function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function Mean(ByVal controlName As String) As Decimal
Return FormulaUtils.Mean(Me, controlName)
End Function
''' <summary>
''' Average of the rows in the table control.
''' This function is called as [Product]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the AVERAGE function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function Average(ByVal controlName As String) As Decimal
Return FormulaUtils.Average(Me, controlName)
End Function
''' <summary>
''' Mode of the rows in the table control.
''' This function is called as [Product]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the MODE function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function Mode(ByVal controlName As String) As Decimal
Return FormulaUtils.Mode(Me, controlName)
End Function
''' <summary>
''' Median of the rows in the table control.
''' This function is called as [Product]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the MEDIAN function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function Median(ByVal controlName As String) As Decimal
Return FormulaUtils.Median(Me, controlName)
End Function
''' <summary>
''' Range of the rows in the table control.
''' This function is called as [Product]TableControl.COUNTA().
''' To make sure all the formula functions are in the same location, we call
''' the RANGE function in the FormulaUtils class, which actually does the work
''' and return the value. The function in FormulaUtils will need to know the
''' TableControl, so it is passed as the first instance.
''' </summary>
''' <param name="controlName">The string name of the UI control (e.g., "UnitPrice") </param>
''' <returns>The total number of rows in the table control.</returns>
Public Function Range(ByVal controlName As String) As Decimal
Return FormulaUtils.Range(Me, controlName)
End Function
End Class
End Namespace