Home > Articles > Programming

Windows Client for the XML Web Services Four Function Calculator

📄 Contents

  1. Hour 8: Windows Client for the Four Function Calculator
  2. Building a Proxy Class with WSDL.exe
  3. Summary
  4. Q&A
  5. Workshop
  • Print
  • + Share This
Here you will explore the basics of creating Windows-based desktop applications that communicate with XML Web Services. You will learn how to use Visual Studio.NET to create proxy classes that handle calls to the service. Finally, you will learn how to control Visual Studio.NET-generated proxies in order to have far greater control over the way your applications work with XML Web Services.

See all Sams Teach Yourself on InformIT Web Development Tutorials.

This chapter is from the book

In this hour, you will learn to create client applications that consume XML Web services. You will also learn how to create proxy classes that enable your application code and XML Web services to easily communicate via SOAP messages. Also in this hour, you will see how to use the WebServiceUtil.exe file to accomplish many important XML Web service–related tasks.

In this hour, we will discuss the following items:

  • Consuming XML Web services

  • Using dialogs to create proxy classes

  • Adding Web references

  • Using the WSDL.exe

Creating a Client Application

Since an XML Web service lacks any real interface of its own, it requires that client applications be built to use its functionality. Client applications can range from ASP applications and Windows-native applications to simple Web pages that use get and post form methods to communicate with a service.

In Hour 9, you will learn to create applications that make use of XML Web services via scripting code and form methods; for now, we will focus on creating Windows-native clients and ASP applications that use XML Web services.

Building the Four Function Calculator Client Application

Create a Windows application and call it CalcClient. Create a form in the CalcClient application that contains three text boxes and four buttons. Set up the form to look like Figure 8.1. For convenience, leave the name property of all the controls to the default settings (that is, Button1, Button2, and so on).

Figure 8.1 The client for the four function calculator.

Proxy Classes

To use your four function calculator XML Web service, you need to create a proxy class to handle the calls to your service. What the proxy class does is expose methods to your application that are identical to the methods used by the XML Web service. For example, if you have an XML Web service method named Chance that accepts an integer and a string and returns a long, your proxy class will also have a method named Chance that accepts and integer and a string and returns a long.

Behind the scenes, the proxy class wraps your parameters (an integer and a string in this example) into a SOAP call to the Web class method (Chance in this case). The Web class then returns a SOAP package containing the long return value to the proxy class, which unwraps it and passes the long value to your application.

Creating the Proxy Class

To create the proxy class to your XML Web service, choose Add Web Reference from the Project menu of Visual Studio .NET. When you use this wizard, Visual Studio creates and compiles the proxy class into a DLL and includes a reference to it in your project automatically.

After you choose Add Web Reference, the screen in Figure 8.2 is displayed. From this screen, you are able to choose known local XML Web services by clicking the link Web References or Local Web Server, or you can seek other services via the link Microsoft UDDI. For this example, we will use the local link.

NOTE

If you wish to review how to use UDDI in searching for XML Web services, reread Hour 5.

Figure 8.2 Using the Web Reference dialog.

Now Visual Studio brings up a list of all the discovery (DISCO) files as Linked Reference Groups, related services that are usually members of the same project, on your local server (see Figure 8.3). Search through this listing and find the URL to FourFunctionCalc.disco.

Figure 8.3 Finding the XML Web service on the server.

After you select the link to an XML Web service (in this case, Service1 of your FourFunctionCalc Group), the discovery file is displayed on the screen, and you are provided with links to the contract and documentation for this service (see Figure 8.4). These links are important when you are using multiple XML Web services to develop applications and you cannot remember what they all do.

Figure 8.4 Viewing the DISCO file of the XML Web service.

Choose the link View Documentation to bring up the auto-generated documentation files (seen in Figure 8.5) that you became familiar with in Hour 7. If you choose the View Contract link, the XML Web services WSDL file is displayed in place of documentation file in Figure 8.5.

NOTE

The ability to understand the XML syntax of the WSDL document is a major boon when you are trying to decide whether a given XML Web service meets the needs of your application. If you are having trouble deciphering the WSDL files, go back and reread Hours 2 and 3 again.

Figure 8.5 Viewing the documentation of the XML Web service.

After you have navigated to the service that you wish to reference in your project, click the Add Reference button and Visual Studio.Net will add the appropriate reference to your project and create a proxy class for the service.

Now that Visual Studio.NET has created the proxy class for you and included it in your CalcClient application, you can add any other references that you need for your project. In this case, you will need to add a reference to the System.Web.Services.dll. This DLL exposes some extra functionality that comes in handy when developing XML Web service clients, and it is good practice to include it in your client applications.

To add the System.Web.Services.dll to your project, choose Add Reference from the Project menu. This brings up the Add Reference window, shown in Figure 8.6. Double-click the System.Web.Services.dll to display it in the bottom window, Selected Components. Once you have done this, you can click Okay to close the window and add the reference to your project.

Figure 8.6 Adding a reference to the System.Web. Services.dll.

Using a Web Service Proxy Class in Client Applications

Now that you have a reference to the FourFunctionCalc XML Web service, you can create an instance of it in your application. Add the following line of code to the general declarations section of your client application's Form1.

Dim oCalc As New localhost.Service1()

If you are using C#, your object declaration should be the following:

localHost.Service1 oCalc = New localhost.Service1;

With the new oCalc object created in your application, you can begin using the methods of the XML Web service, via the proxy, in your application. The general syntax for calling a XML Web service's method is

proxyObject.MethodName(args)

where proxyObject is the name of your object, oCalc is the case of your CalcClient application, and MethodName is the name of the method that you are trying to access. Any arguments that the XML Web service's method expects are represented by args.

NOTE

One tremendous benefit of the proxy class is that, because it contains local methods for all the methods exposed by the service, it allows you to take advantage of Visual Studio .NET's autocompletion features. This saves you from having to memorize all of the function calls and their methods when you try to implement a service in your applications.

Listing 8.1 shows the Visual Basic code to add the FourFunctionCalc methods to the button-click events of your form. Each of the calls uses the CInt function to convert the contents of the text boxes into the integer variables that the method requires. You then use the ToString method to convert the type long answer returned by the service's method into a string that can be displayed in the output text box.

Listing 8.1 The Four Function Calculator's Button Events

1:  Protected Sub Button1_Click(ByVal sender As Object, _
2:             ByVal e As System.EventArgs)
3:
4:    TextBox3.Text = oCalc.Add(CInt(TextBox1.Text), _
5:            CInt(TextBox2.Text)).ToString
6:
7:  End Sub
8:
9:  Protected Sub Button2_Click(ByVal sender As Object, _
10:            ByVal e As System.EventArgs)
11:
12:     TextBox3.Text = oCalc.Subtract( _
13:     CInt(TextBox1.Text), CInt(TextBox2.Text)).ToString
14:
15:  End Sub
16:
17:  Public Sub Button3_Click(ByVal sender As Object, _
18:           ByVal e As System.EventArgs)
19:
20:    TextBox3.Text = oCalc.Mulitply(CInt(TextBox1.Text), _
21:            CInt(TextBox2.Text)).ToString
22:
23:  End Sub
24:  Public Sub Button4_Click(ByVal sender As Object, _
25:           ByVal e As System.EventArgs)
26:
27:    TextBox3.Text = oCalc.Divide(CInt(TextBox1.Text), _
28:            CInt(TextBox2.Text)).ToString
29:
30:  End Sub

Once you have finished coding the button-click events, save your project. Now, choose Start from the Build menu, or simply press F5. This will start the CalcClient application, shown in Figure 8.7.

Figure 8.7 The four-function calculator at work.

Try typing some variables and testing that the code works. Remember that we have not added any code to ensure that only integers are typed into the text boxes. If you wish to add code to ensure that the data entered into TextBox1 and TextBox2 is of type integer, you are free to do so.

  • + 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