Home > Articles > Programming > Visual Basic

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Gluing It All Together

At this point, each of the program's interesting forms has SessionState property procedures. The program still needs to use them to save and restore the whole application's session state.

ApplicationSessionState Property get

The program's main MDI form has ApplicationSessionState property procedures that save and restore all of the forms' combined session states. The property get procedure, shown in Listing 4, creates a new XmlDocument, and gives it a node named SessionState. It then calls the MakeFormSessionStateNode subroutine to add the main form's session state to that node.

MakeFormSessionStateNode, shown at the end of Listing 4, makes a temporary node that contains the text of the form's session state. It pulls the temporary node's child containing the form's session state out and moves it into the XML document's SessionState node. It then deletes the temporary node.

This little sleight-of-hand makes creating the form's node easier. It would be more direct to create the form's node and then set its OuterXml property to the form's SessionState value, but OuterXml is a read-only property. The MakeXmlNode subroutine can set the InnerXml property, but that adds an extra layer to the hierarchy. That's why MakeFormSessionStateNode moves the form's session state node up one level in the document hierarchy.

After adding the main MDI form's SessionState to the XML document, the program loops through the forms listed in the m_Forms collection, adding their information to the document.

Listing 4. The ApplicationSessionState Property get Procedure Returns a Representation of the Entire Application's Session State

' Get/set session state for the entire application.
Private Property ApplicationSessionState() As String
  Get
    Dim doc As New XmlDocument()
    Dim root_node As XmlNode
    Dim frm As Form

    ' Make the XML root node.
    root_node = MakeXmlNode(doc, "SessionState")

    ' Make a session state node for 
    ' the main form.
    MakeFormSessionStateNode(root_node, Me)

    ' Make session state nodes for 
    ' the other forms.
    For Each frm In m_Forms
      MakeFormSessionStateNode(root_node, frm)
    Next frm

    ' Return the combined session state.
    Return doc.InnerXml
  End Get
  ...
End Property

' Make a node representing the session state 
' for the form.
Private Sub MakeFormSessionStateNode(ByVal parent As XmlNode, ByVal frm As Object)
  Dim temp_node As XmlNode

  ' Save the form's information. This makes
  ' a node named Temp with a single child 
  ' node holding the form's information.
  temp_node = MakeXmlNode(parent, "Temp", frm.SessionState)

  ' Move the form's information node into 
  ' the parent node.
  parent.AppendChild(temp_node.ChildNodes(0))

  ' Remove the temporary node.
  parent.RemoveChild(temp_node)
End Sub

The following code shows the result. Notice that the SessionState node contains the MainForm and CustomerListForm nodes. If more forms were visible when the program saved its state, the document might contain other CustomerListForm and EmployeeListForm nodes.

<SessionState>
  <MainForm>
    <X>291</X>
    <Y>16</Y>
    <Width>714</Width>
    <Height>508</Height>
  </MainForm>
  <CustomerListForm>
    <ActiveForm />
    <X>0</X>
    <Y>0</Y>
    <Width>701</Width>
    <Height>227</Height>
    <Field1>Company Name</Field1>
    <Field2>City</Field2>
    <Operator1>LIKE</Operator1>
    <Operator2>=</Operator2>
    <Value1>%Inc%</Value1>
    <Value2>Boulder</Value2>
  </CustomerListForm>
</SessionState>"

To be well-formed, an XML document must have a single data root node. In this case, that is the SessionState node. This property procedure and subroutine MakeFormSessionStateNode go to some lengths to ensure that the combined session state has a single root node.

ApplicationSessionState Property set

The ApplicationSessionState property set procedure, shown in Listing 5, takes a string containing session information and uses it to reset the application. It uses the information it has to create an XmlDocument. It then loops through the root data node's children. In the previous XML listing, those are the nodes named MainForm and CustomerListForm.

The procedure examines each of the child nodes' names to see what kind of form it represents. If the node represents the main form, the program sets the main form's SessionState property using the node's value. That makes the main form reset its size and position.

If the node represents some other kind of form, the procedure creates a new form of the appropriate type. Then it sets the new form's SessionState property using the node's value to make the form reload its session state. The procedure sets the form's MDI parent to the main MDI form and displays the new form.

If the form's session state information contains a child named ActiveForm, that form had the focus when the program saved its session state. The procedure saves a reference to the form in the variable active_form. After it has re-created all the forms, the procedure gives that form the focus.

Listing 5. The ApplicationSessionState Property set Procedure Resets the Application's Session State

' Get/set session state for the entire application.
Private Property ApplicationSessionState() As String
  ...
  Set(ByVal Value As String)
    Dim doc As New XmlDocument()
    Dim form_node As XmlNode
    Dim employee_list_form As EmployeeListForm
    Dim customer_list_form As CustomerListForm
    Dim active_form As Form

    ' Load the XML document from the session
    ' state information.
    doc.InnerXml = Value

    ' Loop through the form information nodes.
    For Each form_node In doc.DocumentElement.ChildNodes
      ' Load the appropriate form. 
      Select Case form_node.Name
        Case "MainForm"
          Me.SessionState = form_node.OuterXml
        Case "CustomerListForm"
          customer_list_form = New CustomerListForm()
          customer_list_form.StartPosition = FormStartPosition.Manual
          customer_list_form.SessionState = form_node.OuterXml
          customer_list_form.MdiParent = Me
          customer_list_form.Show()

          ' See if this should be the active form.
          If Not (form_node.Item("ActiveForm") Is Nothing) Then
            active_form = customer_list_form
          End If
        Case "EmployeeListForm"
          employee_list_form = New EmployeeListForm()
          employee_list_form.StartPosition = FormStartPosition.Manual
          employee_list_form.SessionState = form_node.OuterXml
          employee_list_form.MdiParent = Me
          employee_list_form.Show()

          ' See if this should be the active form.
          If Not (form_node.Item("ActiveForm") Is Nothing) Then
            active_form = employee_list_form
          End If
      End Select
    Next form_node

    ' Set the active form.
    If Not (active_form Is Nothing) Then
      active_form.Focus()
    End If
  End Set
End Property

That's about all there is to it. When you select the Save Session command, the program saves the ApplicationSessionState value in the registry. When you restart the program or invoke the Restore Saved Session command, the program sets ApplicationSessionState to the value retrieved from the registry.

Download the program Restore here:

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