Home > Articles > Programming > Windows Programming

  • Print
  • + Share This
This chapter is from the book

I will do some things in the future to make the Survey application even more useful and flexible. I plan to do a couple of things to streamline the source code, too. I'm going to talk about my ideas here, and I might post them on the Web site in the future.

Streamlining the Code

I wrote this chapter so that it was easy to understand. Sometimes, I optimize code and sacrifice code readability as a result. I didn't want that to happen in the chapter examples, so as a result, some code could have been streamlined. The most obvious example in which I could have streamlined code is that for adding parameters to SqlCommand objects. Three lines of code are required to add a parameter along with its value, as shown here:

myCommand.Parameters.Add(New SqlParameter("@ID", SqlDbType.Int))
myCommand.Parameters("@ID").Direction = ParameterDirection.Input
myCommand.Parameters("@ID").Value = nQuestionID

It would be good to create a helper method named AddParameter() that offers a single line of code to do what is done here in three lines of code. By helper method, I'm referring to a method that performs a small amount of functionality, not a full-blown sequence of functionality. We actually need two versions of the AddParameter() method for the Survey application, one for integers and one for strings. The two methods are shown below.

void AddParameter( SqlCommand myCommand, string strParamName,
  int nValue )
{
    myCommand.Parameters.Add( new SqlParameter( strParamName,
       SqlDbType.Int ) );
    myCommand.Parameters[strParamName].Direction =
       ParameterDirection.Input;
    myCommand.Parameters[strParamName].Value = nValue;
}

void AddParameter( SqlCommand myCommand, string strParamName,
  string strValue, int nSize )
{
    myCommand.Parameters.Add( new SqlParameter( strParamName,
      SqlDbType.VarChar, nSize ) );
    myCommand.Parameters[strParamName].Direction =
      ParameterDirection.Input;
    myCommand.Parameters[strParamName].Value = strValue;
}

Sub AddParameter(ByVal myCommand As SqlCommand,_
  ByVal strParamName As string, ByVal nValue As Integer)
    myCommand.Parameters.Add(New SqlParameter(strParamName, _
      SqlDbType.Int))
    myCommand.Parameters(strParamName).Direction = _
      ParameterDirection.Input
    myCommand.Parameters(strParamName).Value = nValue
End Sub

Sub AddParameter(ByVal myCommand As SqlCommand, _
  ByVal strParamName As string, ByVal strValue as string, _
  ByVal nSize As Integer )
    myCommand.Parameters.Add(New SqlParameter(strParamName,_
      SqlDbType.VarChar, nSize))
    myCommand.Parameters(strParamName).Direction = _
      ParameterDirection.Input
    myCommand.Parameters(strParamName).Value = strValue
End Sub

C#

VB

Each of the above methods can be called from Survey application code, thus replacing three lines of code with one. Note one thing, though: These methods add only parameters that have an Input direction.

The following code,

myCommand.Parameters.Add(New SqlParameter("@Text", _
  SqlDbType.VarChar, 254))
myCommand.Parameters("@Text").Direction = ParameterDirection.Input
myCommand.Parameters("@Text").Value = Question.Text

myCommand.Parameters.Add(New SqlParameter("@CategoryID", _
  SqlDbType.Int))
myCommand.Parameters("@CategoryID").Direction = -
  ParameterDirection.Input
myCommand.Parameters("@CategoryID").Value = _
  CategoryList.SelectedIndex

myCommand.Parameters.Add(New SqlParameter("@Enabled", -
  SqlDbType.Int))
myCommand.Parameters("@Enabled").Direction = _
  ParameterDirection.Input
myCommand.Parameters("@Enabled").Value = 0

can be replaced with these three lines:

AddParameter( myCommand, "@Text", Question.Text, 254 )
AddParameter( myCommand, _
   "@CategoryID", CategoryList.SelectedIndex)
AddParameter( myCommand, "@Enabled", 0 )

Using helper methods can reduce the amount of code in your applications. The AddParameter() method is a good example of how you can streamline your code with helper methods.

Here are the tradeoffs to consider when you are creating and using helper functions:

  • Does the helper method really simplify things? It can actually complicate matters if a lot of parameters must be passed.

  • Does the helper method make the code hard to read and thus hard to maintain? If the answer is Yes, then consider avoiding the use of helper functions that make code hard to read, especially if another developer will be maintaining the code.

  • Does the helper function reduce the overall amount of code without obfuscating the code's intent? If so, then the use of helper methods is desirable.

  • Does the helper function offer reusability so that the functionality can be maintained and bugs can be fixed in a single location? If so, then the user of helper methods is desirable.

Creating a GetSurveyInHTML() Method

You might want to create a method in the Web Service that takes a survey question and wraps it in HTML presentation code, by adding the appropriate HTML tags. If doing this would be helpful, then this section will get you started (although you most certainly will change the specifics of the presentation).

The method will start by calling the _GetSurveyData() method to retrieve the survey question and answer data. A single string will be returned to the client application that contains all of the HTML data.

The following method shown in Listing 3.20 creates HTML data that renders a survey question:

Listing 3.20 The GetSurveyInHTML() Method

C#

[WebMethod]
public string GetSurveyInHTML( int nCategoryID, int nQuestionID, string strVoteURL )
{

    // Create the objects we'll need.
    SurveyData sd = _GetSurveyData( nCategoryID, nQuestionID );
    SurveyResults sr = GetResults( sd.nQuestionID );

    // Create the start of the Html data string.
    string strHTMLData =
      "<form name=\"Survey\" method=\"post\" action=\"" +
      strVoteURL +
      "?ID=4\">\r\n";
    strHTMLData += "<script language=\"javascript\">\r\n";
    strHTMLData += "\tfunction ShowResults()\r\n";
    strHTMLData += "\t{\r\n";
    strHTMLData += "\t\tSurveyResults.innerHTML = ";

    // Loop through each answer.
    for( int i=0; i<sd.Answers.Count; i++ )
    {

 // Add the answer, the supporting Html, and the formatted number.
      strHTMLData +=
       ( sd.Answers[i] + ": " + sr.dPercent[i].ToString( ".00" ) +
          "%");
        if( i < sd.Answers.Count - 1 )
        {
            strHTMLData += "<br>";
        }
        else
        {
            strHTMLData += "\r\n";
        }
    }

    // End this part of the Html.
    strHTMLData += "\t{\r\n";
    strHTMLData += "</script>\r\n";
    strHTMLData += ( "<P>" + sd.strQuestion + "<BR>\r\n" );

    // Loop through each answer again.
    for( int i=0; i<sd.Answers.Count; i++ )
    {
        // Create radio button Html code.
   strHTMLData += ( "<INPUT type=\"radio\" name=\"sr\" value=\"" +
          Convert.ToString( i ) + "\"> " +
           sd.Answers[i] + "<BR>\r\n" );
    }

    // Add the Vote button.
    strHTMLData +=
        "<INPUT type=\"submit\" value=\"Vote\">&nbsp; " +
        "<INPUT type=\"button\" +
        " onclick=\"ShowResults()\" value=\"Results\"></P>\r\n";
    strHTMLData += "<div id=\"SurveyResults\"></div>\r\n";
    strHTMLData += "</form>\r\n";

    return( strHTMLData );
}

VB

<WebMethod()> Public Function GetSurveyInHTML(ByVal nCategoryID _
 As _
  Integer, ByVal nQuestionID As Integer, _
  ByVal strVoteURL As String) As String

 ' Create the objects we'll need.
 Dim sd As SurveyData = _GetSurveyData(nCategoryID, nQuestionID)
    Dim sr As SurveyResults = GetResults(sd.nQuestionID)

    ' Create the start of the Html data string.
    Dim strHTMLData As String = _
      "<form name=Survey method=post action=" + strVoteURL + _
          "?ID=4>" + vbCrLf
    strHTMLData += ("<script language=javascript>" + vbCrLf)
    strHTMLData += ("function ShowResults()" + vbCrLf)
    strHTMLData += ("    {" + vbCrLf)
    strHTMLData += "        SurveyResults.innerHTML = "

    ' Loop through each answer.
    Dim i As Integer
    For i = 0 To sd.Answers.Count – 1
  ' Add the answer, the supporting Html, and the formatted number.
        strHTMLData += (sd.Answers(i) + ": " + _
          sr.dPercent(i).ToString(".00") + "%")
        If i < sd.Answers.Count - 1 Then
            strHTMLData += "<br>"
        Else
            strHTMLData += vbCrLf
        End If
    Next

    ' End this part of the Html.
    strHTMLData += ("    {" + vbCrLf)
    strHTMLData += ("</script>" + vbCrLf)
    strHTMLData += ("<P>" + sd.strQuestion + "<BR>" + vbCrLf)

    ' Loop through each answer again.
    For i = 0 To sd.Answers.Count – 1

        ' Create radio button Html code.
        strHTMLData += ("<INPUT type=radio name=sr value=" + _
          Convert.ToString(i) + "> " + _
           sd.Answers(i) + "<BR>" + vbCrLf)
    Next

    ' Add the Vote button.
    strHTMLData += _
    ("<INPUT type=submit value=Vote>&nbsp; <INPUT type=button" + _
        " onclick=ShowResults() value=Results></P>" + vbCrLf)
    strHTMLData += ("<div id=SurveyResults></div>" + vbCrLf)
    strHTMLData += ("</form>" + vbCrLf)

    Return (strHTMLData)
End Function

Adding a ResetResults() Method

At times, the results for a question need to be reset to zero. This reset might happen on a schedule, or as part of the administrative portion of the application. This section presents a method that can be added to the Web Service to do this, and it can be seen in Listing 3.21.

Listing 3.21 The ResetResults() Method

C#

[WebMethod]
public string ResetResults( int nQuestionID )
{
SqlConnection myConnection =
 new SqlConnection(
   Convert.ToString(Application["DBConnectionString"]));

    try
    {
        myConnection.Open();
        string strSql =
          "update Answers set Cnt=0 where QuestionID=" +
          Convert.ToString( nQuestionID );
        SqlCommand myCommand =
          new SqlCommand( strSql, myConnection );
        myCommand.ExecuteNonQuery();
        myConnection.Close();
    }
    catch( Exception ex )
    {
        if( myConnection.State == ConnectionState.Open )
        {
            myConnection.Close();
        }
    }
}

VB

<WebMethod()> Public Function ResetResults(ByVal nQuestionID As _
  Integer)
    Dim myConnection As New _
      SqlConnection(Convert.ToString(Application("DBConnectionString")))

    Try
        myConnection.Open()
        Dim strSql as string = _
          "update Answers set Cnt=0 where QuestionID=" + _
          Convert.ToString(nQuestionID)
        Dim myCommand As New SqlCommand(strSql, myConnection)
        myCommand.ExecuteNonQuery()
        myConnection.Close()
    Catch ex As Exception
        If myConnection.State = ConnectionState.Open Then
            myConnection.Close()
        End If
    End Try
End Function
  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020