Export (0) Print
Expand All

How to: Find Supported Members of the .NET Compact Framework in the Class Library

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

This topic describes three strategies for finding members of the .NET Compact Framework:

  • Locating the subset of classes in the .NET Framework Class Library that belong to the .NET Compact Framework by using topic filters. If you are using either Visual Studio or Windows SDK, topic filters are available in the table of contents, but only when you use the local Help Combined Help Collection.

  • Locating the subset of members within a class that are supported by the .NET Compact Framework by using a document-level member filter called the Frameworks filter. The Frameworks filter is only available on member topics (topics that list the members that belong to a class).

  • Checking reference topics for device platform and version support, as well as platform-specific behavior.

Note Note

The search strategies differ slightly, depending on whether you are using Visual Studio, Windows SDK, or the online MSDN Library.

Using a topic filter, you may restrict the information that is displayed in the table of contents and index. Thus, you may display only:

  • Conceptual content that is relevant to the .NET Compact Framework.

  • Namespaces that contain types that are supported by the .NET Compact Framework.

  • Types supported by the .NET Compact Framework.

  • Method and constructor overloads that are supported by the .NET Compact Framework.

    Note Note

    Inherited members do not appear in the table of contents: this is true whether or not filtering is used.

To use topic filters

  • If you are using either Visual Studio or Windows SDK, open local Help, and then open the Contents pane.

  • Click the Filter by list option.

    If you are using Windows SDK, select the .NET Compact Framework filter. If you are using Visual Studio, select the Smart Device Development filter.

A document-level (Frameworks) filter is located at the top of each member summary topic. It enables you to display only the members of a class or interface that are supported by the .NET Compact Framework. Each class or interface contains general member summary topics as well as member topics for methods, properties, events, and overloads, if any. Framework filtering is supported in all member topics.

To use a document-level (Frameworks) filter on a member summary topic

  1. In a member page such as AppDomain Members, point to Frameworks in the non-scrolling region at the top of the topic.

  2. Select only the Include .NET Compact Framework Members check box. The member page will display only the members of the class that are supported by the .NET Compact Framework.

  3. Now, change the Frameworks filter so that all options are checked. Notice that members of the .NET framework that are not supported by the .NET Compact Framework can be distinguished from supported members of the .NET Compact Framework by an icon. The icon, which looks like a Smartphone, is located in the first column of the table.

    Note Note

    Once you set a Frameworks filter, it applies to all classes and interfaces in the class library.

Reference Topics

The following reference topic sections also provide information on device platform and version support, as well as platform-specific behavior:

  • The "Platforms" section lists supported platforms such as Windows Mobile for Pocket PC, Windows Mobile for Smartphone, and Windows Embedded CE for types and members that are supported by the .NET Compact Framework. Windows Embedded CE includes devices that run Windows Embedded CE but are not Pocket PCs or Smartphones.

  • The "Version Information" section indicates which version of the .NET Compact Framework supports a particular type or member.

    Note Note

    In a few cases, the "Version Information" section in a reference topic specifies .NET Compact Framework support, but some or all of the mobile device platforms are missing from the "Platforms" section. This is by design and indicates that although the member is present in the .NET Compact Framework assemblies, it is supported only on a subset of platforms (zero or more).

At the end of a reference topic's "Remarks" section, you will find any platform notes that apply, such as how a particular method operates on a mobile device platform. When present, a platform note for the .NET Compact Framework begins with the following subheading: Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform note.

For a list of all device platforms and platform versions supported by the .NET Compact Framework, see Devices and Platforms Supported by the .NET Compact Framework.

Show:
© 2014 Microsoft