Home > Articles > Programming > C#

Universal Windows Apps with XAML and C# Unleashed: Threading, Windows, and Pages

📄 Contents

  1. Understanding the Threading Model for Universal Apps
  2. Displaying Multiple Windows
  3. Navigating Between Pages
  4. Summary
This chapter from Universal Windows Apps with XAML and C# Unleashed begins by examining a very important topic, although one that many developers take for granted: the threading model for universal apps. This background is especially helpful for the advanced feature of writing an app that displays multiple windows, which is the second topic in this chapter. The third and final topic—navigating between a window’s pages—is a feature leveraged by just about every real-world app.
This chapter is from the book

Understanding the Threading Model for Universal Apps

Universal apps have two types of threads that can run your code: UI threads and background threads. (Other types of threads exist, but they are implementation details.) As much as possible, a UI thread should be kept free to process input and update UI elements. Therefore, long-running work should always be scheduled on a background thread.

Typically, an app has a single UI thread, but that’s only because an app typically has a single window. Each window has its own UI thread, so an app with multiple windows (covered in the upcoming “Displaying Multiple Windows” section) has multiple UI threads.

If you have a long-running computation to perform, which therefore isn’t appropriate for a UI thread, you don’t get to explicitly create a background thread for the task. Instead, you schedule it via a static RunAsync method on the Windows.System.Threading.ThreadPool class. Windows manages all background threads for you.

There is always a main UI thread, even if the corresponding main window has not yet been shown. For example, if an app is activated via a contract such as the File Picker contract (see Chapter 21, “Leveraging Contracts”), the app typically displays a special file-picking window and never displays its main window. Yet the app has two UI threads running in this scenario, so your code can always count on global state created by the main thread.

UI objects must be created and called on a UI thread. This includes every class deriving from DependencyObject, which is most classes in the XAML UI Framework. Outside of the XAML UI Framework, most Windows Runtime objects can be created and used on any thread, and you control their lifetime. This makes them very natural to use in C# without worrying about threading or COM-style apartments. Such objects are called agile objects.

Awaiting an Asynchronous Operation

Windows Runtime APIs are designed to make it really hard to block a UI thread. Whenever the Windows Runtime exposes a potentially-long-running operation, it does so with an asynchronous method that performs its work on a background thread. You can easily identify such methods by their Async suffix. And they are everywhere. For example, showing a MessageDialog (discussed in Chapter 14, “Other Controls”) requires a call to ShowAsync:

MessageDialog dialog = new MessageDialog("Title");
IAsyncOperation<IUICommand> operation = dialog.ShowAsync();
// The next line of code runs in parallel with ShowAsync's background work
MoreCode();

Asynchronous methods in the Windows Runtime return one of several interfaces such as IAsyncOperation or IAsyncAction. Asynchronous methods in .NET return a Task. These are two different abstractions for the same set of asynchronous patterns. The System.WindowsRuntimeSystemExtensions class provides several AsTask extension methods for converting one of these interfaces to a Task, as well as AsAsyncOperation and AsAsyncAction extension methods for converting in the opposite direction.

In the preceding code snippet, when ShowAsync is called in this manner, the call returns immediately. The next line of code can run in parallel with the work being done by MessageDialog on a different thread. When ShowAsync’s work is done (because the user dismissed the dialog or clicked one of its buttons), MessageDialog communicates what happened with an IUICommand instance. To get this result, the preceding code must set operation’s Completed property to a delegate that gets called when the task has finished. This handler can then call operation’s GetResults method to retrieve the IUICommand.

Of course, such code is pretty cumbersome to write, and the proliferation of asynchronous methods would result in an explosion of such code if it weren’t for the C# await language feature. When a method returns one of the IAsyncXXX interfaces or a Task, C# enables you to hide the complexity of waiting for the task’s completion. For the ShowAsync example, the resulting code can look like the following:

async Task ShowDialog()
{
  MessageDialog dialog = new MessageDialog("Title");
  IUICommand command = await dialog.ShowAsync();
  // The next line of code does not run until ShowAsync is completely done
  MoreCodeThatCanUseTheCommand(command);
}

When the ShowAsync call is made in this manner, the current method’s execution stops—without blocking the current thread—and then resumes once the task has completed. This enables the code to retrieve the IUICommand object as if ShowAsync had synchronously returned it, rather than having to retrieve it from an intermediate object in a convoluted fashion. You can only use the await keyword in a method that is marked with an async keyword. The async designation triggers the C# compiler to rewrite the method’s implementation as a state machine, which is necessary for providing the handy await illusion.

People commonly refer to this pattern as “awaiting a method,” but you’re actually awaiting the returned IAsyncXXX or Task object. As before, the method actually returns promptly. This is clearer if the preceding code is expanded to the following equivalent code:

async Task ShowDialog()
{
  MessageDialog dialog = new MessageDialog("Title");
  IAsyncOperation<IUICommand> operation = dialog.ShowAsync();
  IUICommand command = await operation;
  // The next line of code does not run until the operation is done
  MoreCodeThatCanUseTheCommand(command);
}

It’s also worth noting that the async designation does not appear in the metadata for a method when it is compiled. It is purely an implementation detail. Again, you’re not awaiting a method; it simply happens to return a data type that supports being awaited.

Notice that the sample ShowDialog method returns a Task, which seems wrong because the method does not appear to return anything. However, the async-triggered rewriting done by the C# compiler does indeed return a Task object. This enables an asynchronous operation to be chained from one caller to the next. Because ShowDialog returns a Task, its caller could choose to await it.

If an async method actually returns something in its visible source code, such as the command object in the preceding code, then it must return Task<T>, where T is the type of the object being returned. In this example, it would be Task<IUICommand>. The C# compiler enforces that an async method must either return Task, Task<T>, or void. This means that ShowDialog could be rewritten with async void instead of async Task and it would still compile. You should avoid this, however, because it breaks the composition of asynchronous tasks.

Transitioning Between Threads

Occasions often arise when one thread needs to schedule work to be executed on another thread. For example, although events on XAML objects are raised on the same UI thread that created the object, this is usually not the case for non-UI objects in the Windows Runtime. Instead, they are raised on whatever background thread happens to be doing the work.

An example of this can be seen with the events defined by MediaCapture, a class described in Chapter 13, “Audio, Video, and Speech.” The following code incorrectly tries to update the UI to notify the user about a failure to capture video from the camera:

common5.jpg
// A handler for MediaCapture's Failed event
void Capture_Failed(MediaCapture sender, MediaCaptureFailedEventArgs e)
{
  // This throws an exception:
  this.textBlock.Text = "Failure capturing video.";
}

The exception thrown explains, “The application called an interface that was marshalled for a different thread. (Exception from HRESULT: 0x8001010E (RPC_E_WRONG_THREAD)).”

With DependencyObject’s Dispatcher property of type CoreDispatcher, however, you can marshal a call back to the proper UI thread needed to update the TextBlock. It can be used as follows:

// A handler for MediaCapture's Failed event
async void Capture_Failed(MediaCapture sender, MediaCaptureFailedEventArgs e)
{
  await this.Dispatcher.RunAsync(CoreDispatcherPriority.Normal, () =>
  {
    // This now works, because it's running on the UI thread:
    this.textBlock.Text = "Failure capturing video.";
  });
}

Here, an anonymous method is used for RunAsync’s second parameter (which must be a parameterless DispatchedHandler delegate) to keep the code as concise as possible. The code must be scheduled to run at one of the following priorities, from highest to lowest: High (which should never be used by app code), Normal, Low, and Idle (which waits until the destination thread is idle with no pending input).

This CoreDispatcher mechanism is also how one window can communicate with another window. Each Window, along with related Windows Runtime abstractions, expose a Dispatcher property that can schedule a delegate to run on its own UI thread.

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